APIs
This section covers the details of the APIs supported by Marketing Catalog microservices.
To learn about Reference data and APIs, see the Reference APIs section.
- Version 1.0.0
- Version 2.0.0
Version 1.0.0
The following are the supported APIs in Version 1.0.0.
You can refer the Swagger Spec of the Marketing Catalogue microservice APIs for more information.
getProductForMCV1
This API is used to retrieve an existing product information for the provided productReference and can be retrieved based on currency.
GET/product/marketingCatalogue/products/{productRef}
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/{productRef}Response
{
"marketingCatalogue": {
"productLineId": "PL20200J33YH",
"productLineRef": "LENDING",
"productLineName": "Lending",
"externalIndicator": false,
"productGroup": {
"productGroupId": "PG20200J33YH",
"productGroupRef": "HOME.EQUITY",
"productGroupName": "Home Equity",
"branchRef": "GB0010001",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": false,
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
],
"product": {
"productId": "PR20200J33YH",
"productRef": "HOME.EQUITY.LOAN",
"productName": "Home Equity Loan",
"branchRef": "GB0010001",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"status": "Active",
"apr": "0.53",
"externalIndicator": false,
"purposes": [
"Onboarding"
],
"extensionData": {},
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productDetails": [
{
"productDetailsId": "PD20200J33YH",
"currency": "USD",
"debitInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
],
"creditInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
]
}
],
"productFeatures": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
}
}
}updateProductForMCV1
This API is used to update an existing product for the provided productReference.
PUT/product/marketingCatalogue/products/{productRef}
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/{productRef}Request
{
"productLine": "LENDING",
"productGroup": "HOME.EQUITY",
"productName": "Home Equity Loan",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"externalIndicator": false,
"apr": 0.53,
"extensionData": {},
"purposes": [
"Onboarding"
],
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productDetails": [
{
"productDetailsId": "PD20200J33YH",
"currency": "USD",
"debitInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
],
"creditInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
]
}
],
"productFeatures": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}deleteProductForMCV1
This API is used to delete the Product records for a particular productReference.
DELETE/product/marketingCatalogue/products
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products
Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
} createProductForMCV1
This API is used to create a new product for the provided product data.
POST/product/marketingCatalogue/products
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products
Request
{
"productLine": "LENDING",
"productGroup": "HOME.EQUITY",
"productRef": "HOME.EQUITY.LOAN",
"branchRef": "GB0010001",
"productName": "Home Equity Loan",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"externalIndicator": false,
"apr": 0.53,
"extensionData": {},
"purposes": [
"Onboarding"
],
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productDetails": [
{
"currency": "USD",
"debitInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
],
"creditInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
]
}
],
"productFeatures": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}getAllProductsForMCV1
This API is used to retrieve all the products available in the catalogue or based on the productGroup and purpose.
GET/product/products/marketingCatalogue
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/products/marketingCatalogue
Response
{
"marketingCatalogue": [
{
"productLineId": "PL20200J33YH",
"productLineRef": "LENDING",
"productLineName": "Lending",
"externalIndicator": false,
"productGroups": [
{
"productGroupId": "PG20200J33YH",
"productGroupRef": "HOME.EQUITY",
"productGroupName": "Home Equity",
"branchRef": "GB0010001",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": false,
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
],
"products": [
{
"productId": "PR20200J33YH",
"productRef": "HOME.EQUITY.LOAN",
"productName": "Home Equity Loan",
"branchRef": "GB0010001",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"status": "Active",
"apr": "0.53",
"externalIndicator": false,
"purposes": [
"Onboarding"
],
"extensionData": {},
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productDetails": [
{
"productDetailsId": "PD20200J33YH",
"currency": "USD",
"debitInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
],
"creditInterests": [
{
"type": "SINGLE",
"periodicIndex": "05"
}
]
}
],
"productFeatures": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
]
}
]
}
]
}updatePurposeInProductForMCV1
This API is used to update the purpose for the products with the given productReference.
PUT/product/marketingCatalogue/purposes/products
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/purposes/products
Request
{
"purposes": [
"Onboarding"
]
} Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
} updateDescriptionInProductForMCV1
This API is used to update description for an existing product or a product feature.
PUT/product/marketingCatalogue/products/{productRef}/descriptions
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/{productRef}/descriptionsRequest
{
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productFeatures": [
{
"type": "e-Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better"
}
]
} Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
} updateDescriptionInProductgroupForMCV1
This API is used to update description for an existing product group.
PUT/product/marketingCatalogue/productGroups/{productGroupRef}/descriptions
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/productGroups/{productGroupRef}/descriptionsRequest
{
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property"
}Response
{
"productGroupId": "PG20200J33YH",
"status": "Success",
"message": "Completed successfully"
}getProductFeaturesForMCV1
This API is used to retrieve a product features detail based on productRef.
GET/product/marketingCatalogue/products/{productRef}/features
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/{productRef}/featuresResponse
{
"features": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
]
} createProductFeaturesForMCV1
This API is used to create the features for a particular product.
POST/product/marketingCatalogue/products/{productRef}/features
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/{productRef}/featuresRequest
{
"features": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
]
} Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
} updateProductFeaturesForMCV1
This API is used to update an existing product features for a product.
PUT/product/marketingCatalogue/products/{productRef}/features
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/{productRef}/featuresRequest
{
"features": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
]
} Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
} deleteProductFeaturesForMCV1
This API is used to delete all the features for a particular product or deletes based on the feature type provided.
DELETE/product/marketingCatalogue/products/{productRef}/features
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/{productRef}/featuresResponse
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
} getPeriodicInterestsForMCV1
This API is used to retrieve an existing periodic interest details.
GET/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterestsResponse
{
"periodicInterests": [
{
"periodicIntId": "PI20200J33YH",
"period": "6M",
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"branchRef": "GB0010001",
"periodicRates": [
{
"minAmount": 10000,
"maxAmount": "90000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
}
],
"extensionData": {}
}
]
}createPeriodicInterestsForMCV1
This API is used to create the periodic interest along with appropriate rates for given periods based on the indexkey and currency of a particular product.
POST/product/marketingCatalogue/products/interests/periodicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/interests/periodicInterests
Request
{
"periodicInterests": [
{
"period": "6M",
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"branchRef": "GB0010001",
"periodicRates": {
"minAmount": 10000,
"rates": [
{
"maxAmount": "90000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
}
]
},
"extensionData": {}
}
]
} Response
{
"periodicIntId": "PI20200J33YH",
"status": "Success",
"message": "Completed successfully"
} updatePeriodicInterestsForMCV1
This API is used to update an already existing periodic interest details for the provided periodic Interest Id.
PUT/product/marketingCatalogue/products/interests/periodicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/interests/periodicInterests
Request
{
"periodicInterests": [
{
"periodicIntId": "PI20200J33YH",
"period": "6M",
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"branchRef": "GB0010001",
"periodicRates": {
"minAmount": 10000,
"rates": [
{
"maxAmount": "90000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
}
]
},
"extensionData": {}
}
]
} Response
{
"periodicIntId": "PI20200J33YH",
"status": "Success",
"message": "Completed successfully"
} deletePeriodicInterestsForMCV1
This API is used to delete all the periodic interests for a particular periodicIntId.
DELETE/product/marketingCatalogue/products/interests/periodicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/marketingCatalogue/products/interests/periodicInterests
Response
{
"periodicIntId": "PI20200J33YH",
"status": "Success",
"message": "Completed successfully"
} createReferenceForMCV1
This API is used to create a reference data for the provided reference type.
POST/reference/references/marketingCatalogue
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/references/marketingCatalogue
Request
{
"references": {
"FeatureType": [
{
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"featureType": "e-Statement",
"detailedDesc": "Electronic Statement will be automatically sent for the product when opted in for this feature"
}
],
"DayBasis": [
{
"dayBasisId": "A",
"description": "Day Basis",
"intBasis": "DayBasis"
}
]
}
} Response
{
"referenceType": "FeatureType",
"status": "Success",
"message": "Completed successfully"
} updateReferenceForMCV1
This API is used to update an existing Reference data for the provided type.
PUT/reference/references/marketingCatalogue
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/references/marketingCatalogue
Request
{
"references": {
"FeatureType": [
{
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"featureType": "e-Statement",
"detailedDesc": "Electronic Statement will be automatically sent for the product when opted in for this feature"
}
],
"DayBasis": [
{
"dayBasisId": "A",
"description": "Day Basis",
"intBasis": "DayBasis"
}
]
}
}Response
{
"referenceType": "FeatureType",
"status": "Success",
"message": "Completed successfully"
}getReferenceForMCV1
This API is used to retrieve all the Reference Data or for the provided reference type.
GET/reference/references/marketingCatalogue
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/references/marketingCatalogue
Response
{
"references": {
"FeatureType": [
{
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"featureType": "e-Statement",
"detailedDesc": "Electronic Statement will be automatically sent for the product when opted in for this feature"
}
],
"DayBasis": [
{
"dayBasisId": "A",
"description": "Day Basis",
"intBasis": "DayBasis"
}
]
}
}addReferenceForMCV1
This API is used to create reference data with given details.
POST/reference/marketingCatalogue/referenceTypes/{referenceType}
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/referenceTypes/{referenceType}Request
{
"references": {
"FeatureType": [
{
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"featureType": "e-Statement",
"detailedDesc": "Electronic Statement will be automatically sent for the product when opted in for this feature"
}
],
"DayBasis": [
{
"dayBasisId": "A",
"description": "Day Basis",
"intBasis": "DayBasis"
}
]
}
} Response
{
"referenceType": "FeatureType",
"status": "Success",
"message": "Completed successfully"
} deleteReferenceForMCV1
This API is used to delete all the Reference Data for a particular type or for the provided reference id.
DELETE/reference/marketingCatalogue/referenceTypes/{referenceType}
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/referenceTypes/{referenceType}Response
{
"referenceType": "FeatureType",
"status": "Success",
"message": "Completed successfully"
} createProductLinesForMCV1
This API is used to create Product Lines which is dominant(ranked at a higher level) and top of the hierarchy in the marketing catalog.
POST/reference/marketingCatalogue/productLines
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/productLines
Request
{
"productLines": [
{
"productLineRef": "LENDING",
"productLineName": "Lending",
"externalIndicator": false
}
]
} Response
{
"referenceType": "ProductLine",
"status": "Success",
"message": "Completed successfully"
} updateProductLinesForMCV1
This API is used to update product Lines in the marketing catalog.
PUT/reference/marketingCatalogue/productLines
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/productLines
Request
{
"productLines": [
{
"productLineRef": "LENDING",
"productLineName": "Lending",
"externalIndicator": false
}
]
}Response
{
"referenceType": "ProductLine",
"status": "Success",
"message": "Completed successfully"
}getProductLinesForMCV1
This API is used to retrieve all the product Lines in the marketing catalog.
GET/reference/marketingCatalogue/productLines
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/productLines
Response
{
"productLines": [
{
"productLineId": "PL20200J33YH",
"productLineRef": "LENDING",
"productLineName": "Lending",
"externalIndicator": false
}
]
}createProductGroupsForMCV1
This API is used to create Product Groups for an existing product line and forms the middle level of the hierarchy on the marketing catalog.
POST /reference/marketingCatalogue/productGroups
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/productGroups
Request
{
"productGroups": [
{
"productLineRef": "LENDING",
"productGroupRef": "HOME.EQUITY",
"productGroupName": "Home Equity",
"branchRef": "GB0010001",
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": false,
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
]
} Response
{
"referenceType": "ProductGroup",
"status": "Success",
"message": "Completed successfully"
} updateProductGroupsForMCV1
This API is used to update an existing product group.
PUT/reference/marketingCatalogue/productGroups
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/productGroups
Request
{
"productGroups": [
{
"productLineRef": "LENDING",
"productGroupRef": "HOME.EQUITY",
"productGroupName": "Home Equity",
"branchRef": "GB0010001",
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": false,
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
]
}Response
{
"referenceType": "ProductGroup",
"status": "Success",
"message": "Completed successfully"
}getProductGroupsForMCV1
This API is used to retrieve all the existing Product Group based on the product line.
GET/reference/marketingCatalogue/productGroups
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/productGroups
Response
{
"productGroups": [
{
"productGroupId": "PG20200J33YH",
"productGroupRef": "HOME.EQUITY",
"productLineId": "PL20200J33YH",
"productLineRef": "LENDING",
"productGroupName": "Home Equity",
"branchRef": "GB0010001",
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": false,
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
]
}deleteProductGroupsForMCV1
This API is used to delete all the Product Group records for a particular productGroupId.
DELETE/reference/marketingCatalogue/productGroups
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/marketingCatalogue/productGroups
Response
{
"referenceType": "ProductGroup",
"status": "Success",
"message": "Completed successfully"
} Version 2.0.0
The following are the supported APIs in Version 2.0.0.
You can refer the Swagger Spec of the Marketing Catalogue microservice APIs for more information.
getProductForMCV2
This API is used to
retrieve an existing product information for the provided productReference and can be retrieved based on currency.
GET/product/marketingCatalogue/products/{productRef}
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}Response
{
"marketingCatalogue": {
"productLineId": "PL20200J33YH",
"productLineRef": "LENDING",
"productLineName": "Lending",
"externalIndicator": false,
"productGroup": {
"productGroupId": "PG20200J33YH",
"productGroupRef": "HOME.EQUITY",
"productGroupName": "Home Equity",
"branchRef": "GB0010001",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": false,
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
],
"product": {
"productId": "PR20200J33YH",
"productRef": "HOME.EQUITY.LOAN",
"productName": "Home Equity Loan",
"branchRef": "GB0010001",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"status": "Active",
"apr": "0.53",
"externalIndicator": false,
"purposes": [
"Onboarding"
],
"overdraftAmount": 10000,
"extensionData": {},
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productConditions": [
{
"productConditionsId": "PC20200J33YH",
"currency": "USD",
"interestDetails": [
{
"interestDetailsId": "IN20200J33YH",
"property": "PRINCIPALINT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"rateTierType": "SINGLE",
"dayBasis": "E",
"compoundType": "TWMTH",
"compoundYield": "Yield",
"debitInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": "12000",
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"creditInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": "12000",
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"chargeDetails": [
{
"chargeId": "CH20200J33YH",
"property": "MORTGINSURANCE",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"type": "Adhoc",
"chargeType": "FIXED",
"chargeCurrency": "USD",
"fixedAmount": 450,
"tierType": [
{
"tierType": "LEVEL",
"calcType": "FLAT",
"rate": 12,
"chargeAmount": 700,
"minCharge": 100,
"maxCharge": 1000,
"tierAmount": 1200
}
],
"extensionData": {}
}
],
"paymentSchedules": [
{
"scheduleId": "SH20200J33YH",
"property": "SCHEDULE",
"period": "6M",
"effectiveDate": "2021-01-15",
"paymentTypes": [
{
"paymentType": "CONSTANT",
"method": "DUE",
"payFrequency": "e0Y e1M e0W e0D e0F",
"property": [
"PRINCIPALINT"
],
"paymentDates": [
{
"startDate": "R_START",
"endDate": "R_MATURITY"
}
]
}
],
"extensionData": {}
}
],
"termAmounts": [
{
"termAmountId": "TM20200J33YH",
"property": "DWCOMMITMENT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"amount": 12000,
"term": "25Y",
"extensionData": {}
}
],
"reportingDetails": [
{
"reportingDetailsId": "RE20200J33YH",
"property": "REPORTING",
"period": "",
"effectiveDate": "2021-01-15",
"aprTypes": [
{
"aprType": "APR.DEFAULT",
"excludeProperty": [
"MORTGINSURANCE"
]
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"productFeatures": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
}
}
}updateProductForMCV2
This API is used to update an already existing product for the provided productRef.
PUT/product/marketingCatalogue/products/{productRef}
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}Request
{
"productLine": "LENDING",
"productGroup": "HOME.EQUITY",
"productName": "Home Equity Loan",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"externalIndicator": false,
"apr": 0.53,
"extensionData": {},
"purposes": [
"Onboarding"
],
"overdraftAmount": 10000,
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
}
}
Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}createProductForMCV2
This API is used to create a new product for the provided product data.
POST/product/marketingCatalogue/products
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products
Request
{
"productLine": "LENDING",
"productGroup": "HOME.EQUITY",
"productRef": "HOME.EQUITY.LOAN",
"branchRef": "GB0010001",
"productName": "Home Equity Loan",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"externalIndicator": false,
"apr": 0.53,
"extensionData": {},
"purposes": [
"Onboarding"
],
"overdraftAmount": 10000,
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productConditions": [
{
"currency": "USD",
"interestDetails": [
{
"property": "PRINCIPALINT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"rateTierType": "SINGLE",
"dayBasis": "E",
"compoundType": "TWMTH",
"compoundYield": "Yield",
"debitInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": 0,
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"creditInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": 0,
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"paymentSchedules": [
{
"property": "SCHEDULE",
"period": "6M",
"effectiveDate": "2021-01-15",
"paymentTypes": [
{
"paymentType": "CONSTANT",
"method": "DUE",
"payFrequency": "e0Y e1M e0W e0D e0F",
"property": [
"PRINCIPALINT"
],
"paymentDates": [
{
"startDate": "R_START",
"endDate": "R_MATURITY"
}
]
}
],
"extensionData": {}
}
],
"chargeDetails": [
{
"property": "MORTGINSURANCE",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"type": "Adhoc",
"chargeType": "FIXED",
"chargeCurrency": "USD",
"fixedAmount": 450,
"tierType": [
{
"tierType": "LEVEL",
"calcType": "FLAT",
"rate": 12,
"chargeAmount": 700,
"minCharge": 100,
"maxCharge": 1000,
"tierAmount": 1200
}
],
"extensionData": {}
}
],
"termAmounts": [
{
"property": "DWCOMMITMENT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"amount": 12000,
"term": "25Y",
"extensionData": {}
}
],
"reportingDetails": [
{
"property": "REPORTING",
"period": "",
"effectiveDate": "2021-01-15",
"aprTypes": [
{
"aprType": "APR.DEFAULT",
"excludeProperty": [
"MORTGINSURANCE"
]
}
],
"extensionData": {}
}
],
"extensionData": {}
}
]
}
Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}getAllProductsForMCV2
This API is used to .
GET/product/products/marketingCatalogue
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/products/marketingCatalogue
Response
{
"marketingCatalogue": [
{
"productLineId": "PL20200J33YH",
"productLineRef": "LENDING",
"productLineName": "Lending",
"externalIndicator": false,
"productGroups": [
{
"productGroupId": "PG20200J33YH",
"productGroupRef": "HOME.EQUITY",
"productGroupName": "Home Equity",
"branchRef": "GB0010001",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": false,
"detailedDesc": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
],
"products": [
{
"productId": "PR20200J33YH",
"productRef": "HOME.EQUITY.LOAN",
"productName": "Home Equity Loan",
"branchRef": "GB0010001",
"availableFrom": "2020-01-01",
"availableTo": "3020-01-01",
"status": "Active",
"apr": "0.53",
"externalIndicator": false,
"purposes": [
"Onboarding"
],
"overdraftAmount": 10000,
"extensionData": {},
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDesc": "Home equity loans allow homeowners to borrow against the equity in their residence.Home equity loan amounts are based on the difference between a home's current market value and the mortgage balance due",
"notes": "Earn 4.5% interest on quarterly|+|The low minimum opening deposit is $2500|+|No Fee for ATM withdraw|+|Easy access to online banking|+|Monthly e-Statements to track the transactions|+|Free Cheque book",
"termsConditions": "To qualify for an INFINITY Home Equity Loan relationship,you need to open loan account and home equity loan term can range anywhere from 5-30 years.It allow up to 10 years to withdraw funds, and up to 20 years to repay. A cash-out refinance term can be up to 30 years",
"disclosure": "For more information and terms and conditions governing Home Equity Loan, see applicable Business Product Guide, Business Accounts & Services Disclosure and Agreement with applicable Loan Schedule",
"extensionData": {}
},
"productConditions": [
{
"productConditionsId": "PC20200J33YH",
"currency": "USD",
"interestDetails": [
{
"interestDetailsId": "IN20200J33YH",
"property": "PRINCIPALINT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"rateTierType": "SINGLE",
"dayBasis": "E",
"compoundType": "TWMTH",
"compoundYield": "Yield",
"debitInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": "12000",
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"creditInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": "12000",
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"chargeDetails": [
{
"chargeId": "CH20200J33YH",
"property": "MORTGINSURANCE",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"type": "Adhoc",
"chargeType": "FIXED",
"chargeCurrency": "USD",
"fixedAmount": 450,
"tierType": [
{
"tierType": "LEVEL",
"calcType": "FLAT",
"rate": 12,
"chargeAmount": 700,
"minCharge": 100,
"maxCharge": 1000,
"tierAmount": 1200
}
],
"extensionData": {}
}
],
"paymentSchedules": [
{
"scheduleId": "SH20200J33YH",
"property": "SCHEDULE",
"period": "6M",
"effectiveDate": "2021-01-15",
"paymentTypes": [
{
"paymentType": "CONSTANT",
"method": "DUE",
"payFrequency": "e0Y e1M e0W e0D e0F",
"property": [
"PRINCIPALINT"
],
"paymentDates": [
{
"startDate": "R_START",
"endDate": "R_MATURITY"
}
]
}
],
"extensionData": {}
}
],
"termAmounts": [
{
"termAmountId": "TM20200J33YH",
"property": "DWCOMMITMENT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"amount": 12000,
"term": "25Y",
"extensionData": {}
}
],
"reportingDetails": [
{
"reportingDetailsId": "RE20200J33YH",
"property": "REPORTING",
"period": "",
"effectiveDate": "2021-01-15",
"aprTypes": [
{
"aprType": "APR.DEFAULT",
"excludeProperty": [
"MORTGINSURANCE"
]
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"productFeatures": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "When you register for e-Statements, we will send you monthly e-Statements. This increased frequency enables you to track your account better",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "OPT-IN",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"desc": "Wanted the Bank to authorize and pay overdrafts on the transactions",
"extensionData": {}
}
],
"extensionData": {}
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
]
}
]
}
]
}updateProductConditionsForMCV2
This API is used to update an already existing product with the product conditions. It allows to create new conditions or update an existing condition.
PUT/product/marketingCatalogue/products/{productRef}/productConditions
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}/productConditionsRequest
{
"productConditions": [
{
"productConditionsId": "PC20200J33YH",
"currency": "USD",
"interestDetails": [
{
"interestDetailsId": "IN20200J33YH",
"property": "PRINCIPALINT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"rateTierType": "SINGLE",
"dayBasis": "E",
"compoundType": "TWMTH",
"compoundYield": "Yield",
"debitInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": 0,
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"creditInterests": [
{
"fixedRate": 10,
"floatingIndex": "01",
"periodicIndex": "05",
"periodicPeriod": "6M",
"periodicMethod": "NEXT",
"periodicReset": "e0Y e1M e0W e0D e0F",
"tierAmount": 0,
"marginDetails": [
{
"type": "SingleMargin",
"marginOperand": "ADD",
"marginRate": 5.5,
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"chargeDetails": [
{
"chargeId": "CH20200J33YH",
"property": "MORTGINSURANCE",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"type": "Adhoc",
"chargeType": "FIXED",
"chargeCurrency": "USD",
"fixedAmount": 450,
"tierType": [
{
"tierType": "LEVEL",
"calcType": "FLAT",
"rate": 12,
"chargeAmount": 700,
"minCharge": 100,
"maxCharge": 1000,
"tierAmount": 1200
}
],
"extensionData": {}
}
],
"paymentSchedules": [
{
"scheduleId": "SH20200J33YH",
"property": "SCHEDULE",
"period": "6M",
"effectiveDate": "2021-01-15",
"paymentTypes": [
{
"paymentType": "CONSTANT",
"method": "DUE",
"payFrequency": "e0Y e1M e0W e0D e0F",
"property": [
"PRINCIPALINT"
],
"paymentDates": [
{
"startDate": "R_START",
"endDate": "R_MATURITY"
}
]
}
]
}
],
"termAmounts": [
{
"termAmountId": "TM20200J33YH",
"property": "DWCOMMITMENT",
"period": "6M",
"variation": "",
"effectiveDate": "2021-01-15",
"amount": 12000,
"term": "25Y",
"extensionData": {}
}
],
"reportingDetails": [
{
"reportingDetailsId": "RE20200J33YH",
"property": "REPORTING",
"period": "",
"effectiveDate": "2021-01-15",
"aprTypes": [
{
"aprType": "APR.DEFAULT",
"excludeProperty": [
"MORTGINSURANCE"
]
}
],
"extensionData": {}
}
],
"extensionData": {}
}
]
}
Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}createImageDetailsForMCV2
This API is used to create the image details for a particular product.
POST/product/marketingCatalogue/products/{productRef}/imageDetails
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}/imageDetailsRequest
{
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}updateImageDetailsForMCV2
This API is used to update an existing image details for a product.
PUT/product/marketingCatalogue/products/{productRef}/imageDetails
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}/imageDetailsRequest
{
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}
Response
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}getImageDetailsForMCV2
This API is used to retrieve image details for a particular product.
GET/product/marketingCatalogue/products/{productRef}/imageDetails
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}/imageDetailsResponse
{
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.microservice.temenos.com/resources/images/home_equity.png",
"extensionData": {}
}
]
}deleteImageDetailsForMCV2
This API is used to delete all the image details for a particular product or delete based on the image type provided.
DELETE/product/marketingCatalogue/products/{productRef}/imageDetails
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}/imageDetailsResponse
{
"productId": "PR20200J33YH",
"status": "Success",
"message": "Completed successfully"
}createPeriodicInterestsForMCV2
This API is used to create periodic interest for a product.
POST/product/marketingCatalogue/products/interests/periodicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/interests/periodicInterests
Request
{
"periodicInterests": [
{
"period": "6M",
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"branchRef": "GB0010001",
"periodicRates": {
"minAmount": 10000,
"rates": [
{
"maxAmount": "90000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
}
]
},
"extensionData": {}
}
]
}
Response
{
"periodicIntId": "PI20200J33YH",
"status": "Success",
"message": "Completed successfully"
}updatePeriodicInterestsForMCV2
This API is used to update an existing periodic interest for a product.
PUT/product/marketingCatalogue/products/interests/periodicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/interests/periodicInterests
Request
{
"periodicInterests": [
{
"periodicIntId": "PI20200J33YH",
"periodicRates": {
"minAmount": 10000,
"rates": [
{
"maxAmount": "90000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
}
]
},
"extensionData": {}
}
]
}
Response
{
"periodicIntId": "PI20200J33YH",
"status": "Success",
"message": "Completed successfully"
}getPeriodicInterestsForMCV2
This API is used to retrieve the periodic interest details for a product.
GET/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterestsResponse
{
"periodicInterests": [
{
"periodicIntId": "PI20200J33YH",
"period": "6M",
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"branchRef": "GB0010001",
"restDate": "2021-01-15",
"daysSinceSpot": 2,
"periodicRates": [
{
"minAmount": 10000,
"maxAmount": "90000",
"bidRate": 0.052,
"offerRate": 0.072,
"apr": 0.53
}
],
"extensionData": {}
}
]
}getBasicInterestsForMCV2
This API is used to retrieve an existing basic interest details.
GET/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/basicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/basicInterestsResponse
{
"basicInterests": [
{
"basicIntId": "BI20200J33YH",
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"interestRate": 0,
"negativeInterestRate": 0,
"branchRef": "GB0010001",
"extensionData": {}
}
]
}createBasicInterestsForMCV2
This API is used to create basic interest along with appropriate rates for given indexkey and currency.
POST/product/marketingCatalogue/products/interests/basicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/interests/basicInterests
Request
{
"basicInterests": [
{
"indexKey": "05",
"currency": "USD",
"effectiveDate": "2019-02-09",
"interestRate": 0,
"negativeInterestRate": 0,
"branchRef": "GB0010001",
"extensionData": {}
}
]
}
Response
{
"basicIntId": "BI20200J33YH",
"status": "Success",
"message": "Completed successfully"
}updateBasicInterestsForMCV2
This API is used to update an already existing basic interest details for the provided basic Interest ID.
PUT/product/marketingCatalogue/products/interests/basicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/interests/basicInterests
Request
{
"basicInterests": [
{
"basicIntId": "BI20200J33YH",
"interestRate": 0,
"negativeInterestRate": 0,
"extensionData": {}
}
]
}
Response
{
"basicIntId": "BI20200J33YH",
"status": "Success",
"message": "Completed successfully"
}deleteBasicInterestsForMCV2
This API is used to delete the basic interests for a particular basicIntId.
DELETE/product/marketingCatalogue/products/interests/basicInterests
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/interests/basicInterests
Response
{
"basicIntId": "BI20200J33YH",
"status": "Success",
"message": "Completed successfully"
}getLoanSimulationDetailsForMCV2
This API is used to retrieve data required for loan simulation for the provided product reference.
GET/product/marketingCatalogue/products/{productRef}/loanSimulations
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/product/marketingCatalogue/products/{productRef}/loanSimulationsResponse
{
"productId": "PR20200J33YH",
"productRef": "HOME.EQUITY.LOAN",
"branchRef": "GB0010001",
"currency": "USD",
"repaymentDate": "2021-01-15",
"repaymentFrequency": "e0Y e1M e0W e0D e0F",
"interestConditions": {
"compounding": true,
"compoundingYield": true,
"compoundingFrequency": 12,
"daybasis": "E",
"interest": [
{
"startDate": "2021-01-15",
"rate": 10
}
]
},
"charges": [
{
"property": "MORTGINSURANCE",
"type": "Scheduled",
"amount": 100,
"frequency": "e0Y e1M e0W e0D e0F",
"startDate": "R_START",
"endDate": "R_MATURITY"
}
]
}In this topic
