Microservices
Updated On 24 March 2024 |
Min(s) read
APIs
This section covers the details of the APIs supported by Marketing Catalog microservices.
- V1.0.0
- V2.0.0
V1.0.0
This is the basis version of Marketing Catalog Microservices, which lists both Microservice endpoints and IRF endpoints.
- Microservice Endpoints
- Authenticated IRF Endpoints
Microservice Endpoints
Get PRODUCT AND MARKETING INFORMATION
This API is used to fetch the product and marketing information details for the provided product-ID and currency-ID.
GET/product/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/{productId}/currencies/{currencyId}Response
{
"Items": {
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
}crEATES A PRODUCT AND MARKETING INFORMATION
This API is used to fetch the product and marketing details for the provided product-ID and currency-ID.
POST/product/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8090/ms-marketingcatalog-api/api/v1.0.0/product/{productId}/currencies/{currencyId}Request
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
}UPDATES A PRODUCT AND MARKETING INFORMATION
This API is used to update the product and marketing details for the provided product-ID and currency-ID..
PUT/product/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/{productId}/currencies/{currencyId}Sample Request
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
} Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
} Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-GROUP FOR CURRENCY
This API is used to fetch the product and marketing information in product-group for currency.
GET/product/productGroups/{productGroupId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/productGroups/{productGroupId}/currencies/{currencyId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
] Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-GROUP
This API is used to fetch the product and marketing information in product-group.
GET/product/productGroups/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/productGroups/{productGroupId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-LinE FOR CURRENCY
This API is used to fetch the product and marketing Information in product-line for currency.
GET/product/productLines/{productLineId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/productLines/{productLineId}/currencies/{currencyId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-LINE
This API is used to fetch the product and marketing information in product-line.
GET/product/productLines/{productLineId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/productLines/{productLineId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]
Get PRODUCT LINE IDS
This API is used to fetch all the product lines.
GET/product/productLine
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/productLine
Response
{
"productLine": [
"string"
]
}Get PRODUCT GROUPS IN particular PRODUCT LINE
This API is used to fetch all the product Groups in a particular Product Line.
GET/product/productLine/{productLineId}/productGroup
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/productLine/{productLineId}/productGroupResponse
{
"productGroup": [
{
"productGroupId": "string",
"productGroupName": "string"
}
]
}Get products in product group for a particular product line
This API is used to fetch all the products in a product group for a particular product line.
GET/product/productLine/{productLineId}/productGroup/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/productLine/{productLineId}/productGroup/{productGroupId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]update purpose in the product
This API is used to update purpose in a product.
PUT/product/purpose/product/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/purpose/product/{productId}/currency/{currencyId}Sample Request
{
"purpose": [
"string"
]
}Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
}Get PRODUCTS FOR A PURPOSE
This API is used to fetch all the products for a purpose.
GET/product/purpose/{purposeId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/purpose/{purposeId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Get all Products
This API is used to fetch the list of all products.
GET/product/products
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products
Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Updates description in the product
This API is used to update the description in a product.
PUT/product/description/products/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/description/products/{productId}/currency/{currencyId}Sample Request
{
"productDescription": "string"
}Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
} Authenticated IRF Endpoints
Get PRODUCT AND MARKETING INFORMATION
This API is used to fetch the product and marketing information details for the provided product-ID and currency-ID.
GET/product/products/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/{productId}/currencies/{currencyId}Response
{
"Items": {
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
}crEATES A PRODUCT AND MARKETING INFORMATION
This API is used to fetch the product and marketing details for the provided product-ID and currency-ID.
POST/product/products/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8090/ms-marketingcatalog-api/api/v1.0.0/product/products/{productId}/currencies/{currencyId}Request
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
}UPDATES A PRODUCT AND MARKETING INFORMATION
This API is used to update the product and marketing details for the provided product-ID and currency-ID..
PUT/product/products/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/{productId}/currencies/{currencyId}Sample Request
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
} Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
} Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-GROUP FOR CURRENCY
This API is used to fetch the product and marketing information in product-group for currency.
GET/product/products/productGroups/{productGroupId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productGroups/{productGroupId}/currencies/{currencyId}
Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]
Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-GROUP
This API is used to fetch the product and marketing information in product-group.
GET/product/products/productGroups/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productGroups/{productGroupId}
Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-LinE FOR CURRENCY
This API is used to fetch the product and marketing Information in product-line for currency.
GET/product/products/productLines/{productLineId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productLines/{productLineId}/currencies/{currencyId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Get PRODUCTS AND MARKETING INFORMATION IN PRODUCT-LINE
This API is used to fetch the product and marketing information in product-line.
GET/product/products/productLines/{productLineId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productLines/{productLineId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Get PRODUCT LINE IDS
This API is used to fetch all the product lines.
GET/product/products/productLine
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productLine
Response
{
"productLine": [
"string"
]
}Get PRODUCT GROUPS IN particular PRODUCT LINE
This API is used to fetch all the product Groups in a particular Product Line.
GET/product/products/productLine/{productLineId}/productGroup
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productLine/{productLineId}/productGroupResponse
{
"productGroup": [
{
"productGroupId": "string",
"productGroupName": "string"
}
]
}Get products in product group for a particular product line
This API is used to fetch all the products in a product group for a particular product line.
GET/product/products/productLine/{productLineId}/productGroup/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productLine/{productLineId}/productGroup/{productGroupId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]update purpose in the product
This API is used to update purpose in a product.
PUT/product/purpose/products/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/purpose/products/{productId}/currency/{currencyId}Sample Request
{
"purpose": [
"string"
]
}Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
}Get PRODUCTS FOR A PURPOSE
This API is used to fetch all the products for a purpose.
GET/product/products/purpose/{purposeId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/purpose/{purposeId}Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Get all Products
This API is used to fetch the list of all products.
GET/product/products/productCatalogue
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/products/productCatalogue
Response
[
{
"marketingItems": [
{
"displayName": "string",
"largeIcon": {
"systemId": "string",
"resourcePath": "string"
},
"smallIcon": {
"systemId": "string",
"resourcePath": "string"
},
"availableFrom": "2020-07-19",
"smallMedia": {
"systemId": "string",
"resourcePath": "string"
},
"mediumMedia": {
"systemId": "string",
"resourcePath": "string"
},
"bannerImage": {
"systemId": "string",
"resourcePath": "string"
},
"mediumIcon": {
"systemId": "string",
"resourcePath": "string"
},
"largeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"notes": {
"systemId": "string",
"resourcePath": "string"
},
"availableTo": "2020-07-19",
"detailsURL": "string",
"currencyId": "string",
"productId": "string",
"extraLargeMedia": {
"systemId": "string",
"resourcePath": "string"
},
"termsConditions": {
"systemId": "string",
"resourcePath": "string"
},
"extraLargeIcon": {
"systemId": "string",
"resourcePath": "string"
}
}
],
"productItem": {
"noticePeriod": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"fees": {
"feeAmount": 0,
"feeFrequency": "string"
},
"currencyId": "string",
"debitInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productId": "string",
"minimumAmount": 0,
"maximumAmount": 0,
"overdraftAmount": 0,
"creditInterest": {
"interestMaximumBalance": 0,
"interestMinimumBalance": 0,
"interestType": "string",
"interestRate": 0
},
"productGroupId": "string",
"term": {
"days": 0,
"weeks": 0,
"months": 0,
"years": 0
},
"amount": 0,
"productLineId": "string",
"purpose": [
"string"
],
"productName": "string",
"status": "string",
"productLineDisplayName": "string",
"productGroupName": "string",
"externalIndicator": "string",
"productDescription": "string"
}
}
]Updates description in the product
This API is used to update the description in a product.
PUT/product/description/products/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v1.0.0/product/description/products/{productId}/currency/{currencyId}Sample Request
{
"productDescription": "string"
}Sample Response
{
"productId": "string",
"status": "string",
"message": "string"
} V2.0.0
In this version, the hierarchy of the product catalog is maintained as follows.
- Product Line
- Product group
- Products
- Microservice Endpoints
- Authenticated IRF Endpoints
Microservice Endpoints
Get a PRODUCT
This API is used to fetch the product and marketing information details for the provided product-ID and currency-ID.
GET/product/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/{productId}/currencies/{currencyId}Response
{
"productCatalogue": {
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": {
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": {
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
}
}
}crEATES A PRODUCT
This API is used to fetch the product and marketing details for the provided product-ID and currency-ID.
POST/product/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8090/ms-marketingcatalog-api/api/v2.0.0/product/{productId}/currencies/{currencyId}Request
{
"productCatalogue": {
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": {
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": {
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
}
}
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
}UPDATES A PRODUCT
This API is used to update the product and marketing details for the provided product-ID and currency-ID..
PUT/product/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/{productId}/currencies/{currencyId}Sample Request
{
"productCatalogue": {
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": {
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": {
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
}
}
} Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Get PRODUCTS IN PRODUCT-GROUP FOR CURRENCY
This API is used to fetch the product and marketing information in product-group for currency.
GET/product/productGroups/{productGroupId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/productGroups/{productGroupId}/currencies/{currencyId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCTS IN PRODUCT GROUP
This API is used to fetch the product and marketing information in product-group.
GET/product/productGroups/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/productGroups/{productGroupId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCTS IN PRODUCT LinE FOR CURRENCY
This API is used to fetch the product and marketing Information in product-line for currency.
GET/product/productLines/{productLineId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/productLines/{productLineId}/currencies/{currencyId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCTS IN PRODUCT-LINE
This API is used to fetch the product and marketing information in product-line.
GET/product/productLines/{productLineId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/productLines/{productLineId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCT GROUPS IN particular PRODUCT LINE
This API is used to fetch all the product Groups in a particular Product Line.
GET/product/productLine/{productLineId}/productGroup
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/productLine/{productLineId}/productGroupResponse
{
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"detailDescription": "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": "N",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
} Get products in product group for a particular product line
This API is used to fetch all the products in a product group for a particular product line.
GET/product/productLine/{productLineId}/productGroup/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/productLine/{productLineId}/productGroup/{productGroupId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} update purpose in the product
This API is used to update purpose in a product.
PUT/product/purpose/product/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/purpose/product/{productId}/currency/{currencyId}Sample Request
{
"purposes": [
"Onboarding"
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Get PRODUCTS FOR A PURPOSE
This API is used to fetch all the products for a purpose.
GET/product/purpose/{purposeId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/purpose/{purposeId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get all Products
This API is used to fetch the list of all products.
GET/product/products
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products
Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
}Updates description in the product
This API is used to update the description in a product for the provided currency.
PUT/product/description/products/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/description/products/{productId}/currency/{currencyId}Sample Request
{
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better"
}
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Updates description in product Groups
This API is used to update the description in a Product Groups for the provided productGroupId.
PUT/product/products/productGroup/{productGroupId}/description
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productGroup/{productGroupId}/descriptionSample Request
{
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property"
}Sample Response
{
"productGroupId": "HOME.EQUITY",
"status": "Success",
"message": "string"
} Get PRODUCT Features Details
This API is used to fetch product feature details based on product Id.
GET/product/products/{productId}/features
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/featuresResponse
{
"features": [
{
"type": "eStatement",
"productId": "HOME.EQUITY.LOAN",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
]
}crEATES PRODUCT features
This API is used to create product features for a product Id.
POST/product/products/{productId}/features
Sample URL
http://localhost:8090/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/featuresRequest
{
"features": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
}Updates product features
This API is used to update the product features details for a particular product Id.
PUT/product/products/{productId}/features
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/featuresSample Request
{
"features": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Get all reference data
This API is used to fetch all the reference data.
GET/reference/{referenceId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/reference/{referenceId}Response
{
"optionDispType": [
{
"id": "string",
"description": "string"
}
],
"featureType": [
{
"id": "string",
"description": "string"
}
]
}Authenticated IRF Endpoints
Get a PRODUCT
This API is used to fetch the product and marketing information details for the provided product-ID and currency-ID.
GET/product/products/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/currencies/{currencyId}Response
{
"productCatalogue": {
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": {
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": {
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
}
}
}crEATES A PRODUCT
This API is used to fetch the product and marketing details for the provided product-ID and currency-ID.
POST/product/products/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8090/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/currencies/{currencyId}Request
{
"productCatalogue": {
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": {
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": {
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
}
}
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
}UPDATES A PRODUCT
This API is used to update the product and marketing details for the provided product-ID and currency-ID..
PUT/product/products/{productId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/currencies/{currencyId}Sample Request
{
"productCatalogue": {
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": {
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": {
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
}
}
} Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Get PRODUCTS IN PRODUCT GROUP FOR CURRENCY
This API is used to fetch the product and marketing information in product-group for currency.
GET/product/products/productGroups/{productGroupId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productGroups/{productGroupId}/currencies/{currencyId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCTS IN PRODUCT GROUP
This API is used to fetch the product and marketing information in product-group.
GET/product/products/productGroups/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productGroups/{productGroupId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCTS IN PRODUCT LinE FOR CURRENCY
This API is used to fetch the product and marketing Information in product-line for currency.
GET/product/products/productLines/{productLineId}/currencies/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productLines/{productLineId}/currencies/{currencyId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCTS IN PRODUCT LINE
This API is used to fetch the product and marketing information in product-line.
GET/product/products/productLines/{productLineId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productLines/{productLineId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get PRODUCT GROUPS IN particular PRODUCT LINE
This API is used to fetch all the product Groups in a particular Product Line.
GET/product/products/productLine/{productLineId}/productGroup
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productLine/{productLineId}/productGroupResponse
{
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"detailDescription": "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": "N",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
} Get products in product group for a particular product line
This API is used to fetch all the products in a product group for a particular product line.
GET/product/products/productLine/{productLineId}/productGroup/{productGroupId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productLine/{productLineId}/productGroup/{productGroupId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} update purpose in the product
This API is used to update purpose in a product.
PUT/product/purpose/products/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/purpose/products/{productId}/currency/{currencyId}Sample Request
{
"purposes": [
"Onboarding"
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Get PRODUCTS FOR A PURPOSE
This API is used to fetch all the products for a purpose.
GET/product/products/purpose/{purposeId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/purpose/{purposeId}Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
} Get all Products
This API is used to fetch the list of all products.
GET/product/products/productCatalague
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productCatalague
Response
{
"productCatalogue": [
{
"productLineId": "LENDING",
"productLineDisplayName": "Lending",
"externalIndicator": "N",
"productGroups": [
{
"productGroupId": "HOME.EQUITY",
"productGroupDisplayName": "Home Equity",
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"externalIndicator": "N",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property",
"disclosure": "",
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
],
"products": [
{
"productId": "HOME.EQUITY.LOAN",
"currencyId": "USD",
"noticePeriod": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"debitInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"minimumAmount": 2000,
"maximumAmount": 500000,
"overdraftAmount": 3000,
"creditInterest": {
"interestMaximumBalance": 8,
"interestMinimumBalance": 5,
"interestType": "SINGLE",
"interestRate": 10,
"periodicIndexType": "05"
},
"term": {
"days": 8,
"weeks": 4,
"months": 1,
"years": 1
},
"amount": 7000,
"purposes": [
"Onboarding"
],
"productName": "Home Equity Loan",
"status": "Active",
"externalIndicator": "N",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"prodDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 720,
"width": 120,
"imageUrl": "https://marketingcatalog.Microservice.temenos.com/resources/images/home_equity.png"
}
]
}
]
}
]
}
]
}Updates description in the product
This API is used to update the description in a product for the provided currency.
PUT/product/description/products/{productId}/currency/{currencyId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/description/products/{productId}/currency/{currencyId}Sample Request
{
"productDescription": {
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"detailedDescription": "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": "",
"termsConditions": "",
"disclosure": ""
},
"productFeatures": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better"
}
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Updates description in product Groups
This API is used to update the description in a Product Groups for the provided productGroupId.
PUT/product/products/productGroup/{productGroupId}/description
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/productGroup/{productGroupId}/descriptionSample Request
{
"description": "Home equity is the market value of a homeowner's unencumbered interest in their real property",
"detailDescription": "Home equity is the difference between how much your home is worth and the outstanding balance of all liens on your property"
}Sample Response
{
"productGroupId": "HOME.EQUITY",
"status": "Success",
"message": "string"
} Get PRODUCT Features Details
This API is used to fetch product feature details based on product Id.
GET/product/products/{productId}/features
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/featuresResponse
{
"features": [
{
"type": "eStatement",
"productId": "HOME.EQUITY.LOAN",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
]
}crEATES PRODUCT features
This API is used to create product features for a product Id.
POST/product/products/{productId}/features
Sample URL
http://localhost:8090/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/featuresRequest
{
"features": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
}Updates product features
This API is used to update the product features details for a particular product Id.
PUT/product/products/{productId}/features
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/product/products/{productId}/featuresSample Request
{
"features": [
{
"type": "eStatement",
"description": "When you register for e-statements, we will send you monthly eStatements. This increased frequency enables you to track your account better",
"featureName": "eStatement",
"featureGroup": "",
"sequenceNo": 2,
"isMandatory": false,
"defaultValue": "No",
"option": "",
"optionDispType": "CheckBox",
"optionValues": [
{
"value": "OPT-IN",
"description": ""
}
]
}
]
}Sample Response
{
"productId": "HOME.EQUITY.LOAN",
"status": "Success",
"message": "string"
} Get all reference data
This API is used to fetch all the reference data.
GET/reference/{referenceId}
Sample URL
http://localhost:8095/ms-marketingcatalog-api/api/v2.0.0/reference/{referenceId}Response
{
"optionDispType": [
{
"id": "string",
"description": "string"
}
],
"featureType": [
{
"id": "string",
"description": "string"
}
]
}In this topic