Marketing Catalog
Marketing Catalog APIs helps you to interact with the Marketing Catalog Microservice and its Enterprise APIs. By using these APIs you can manage the marketing information of the core banking products. Marketing Catalog micro service receives marketing information in the form of events (asynchronous call) from the record keeping system.
| Name | Description | Introduced In |
|---|---|---|
| fetchProductList | This API fetches all the products from all the product Groups in every product line. | 2020.04 |
| getProductGroupsByProductLine | This API fetches all the product Groups in a product line. | 2020.04 |
| getProductsByProductGroup | This API fetches the list of all products and marketing information details that belong to a product group. | 2020.04 |
| getProductsForPurpose | This API fetches all the products that are used for a specific purpose. | 2020.04 |
| GetProducts | This API allows the user to fetch the list of all the products and its details. | 2020.10 |
| CreateProduct | This API allows the user to create a product. | 2020.10 |
| UpdateProduct | This API allows the user to update the product details. | 2020.10 |
| GetFeatures | This API allows the user to fetch all the features. | 2020.10 |
| CreateFeature | This API allows the user to create a feature. | 2020.10 |
| UpdateFeature | This API allows the user to update the feature and feature details. | 2020.10 |
| GetProductLines | This API is used to fetch product lines. | 2020.10 |
| CreateProductLines | This API is used to create product lines. | 2020.10 |
| UpdateProductLines | This API is used to update product lines. | 2020.10 |
| GetProductGroups | This API is used to fetch all the product groups. | 2020.10 |
| CreateProductGroups | This API is used to create Product Groups. | 2020.10 |
| UpdateProductGroups | This API is used to update Product Groups. | 2020.10 |
| GetAllProductGroups | This API is used to fetch all the product groups for purpose as Campaign. | 2020.10 |
| GetProductsByproductGroup | API is used to fetch the products for the specific product group. | 2020.10 |
fetchProductList
| Description: | This API fetches all the products from all the product Groups in every product line. |
| Method: | GET |
| URL: | {base_url}/services/data/v1/BankProductManagment/operations/product/fetchProductList |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
None |
| Response: |
View the Response Parameters
Parameters productCatalogue Specifies the details of the product catalog. productCatalogue/externalIndicator Specifies the indicator for the product catalog. productCatalogue/productLineDisplayName Specifies the name of the product line. productCatalogue/productGroups Specifies the various product groups and their details. productCatalogue/productGroups/externalIndicator Specifies the indicator for the product groups. productCatalogue/productGroups/detailDescription Specifies the descriptions for the product detials. productCatalogue/productGroups/disclosure Specifies the disclosure details of the product group. productCatalogue/productGroups/imageDetails Specifies the image details of the products. productCatalogue/productGroups/imageDetails/imageUrl Specifies the URL that is associated with the image. productCatalogue/productGroups/imageDetails/width Specifies the width of the image. productCatalogue/productGroups/imageDetails/imageType Specifies the type of the image. productCatalogue/productGroups/imageDetails/extensionData Specifies the extension data that is associated with the image. productCatalogue/productGroups/imageDetails/height Specifies the height of the image. productCatalogue/productGroups/productGroupId Specifies the ID of the product group to which the products belong. productCatalogue/productGroups/description Specifies the description of the product group. productCatalogue/productGroups/productGroupDisplayName Specifies the name of the product group. productCatalogue/productGroups/extensionData Specifies the extension data that is associated with the product group. productCatalogue/productGroups/products Specifies the list of products, with their details. that is present in a product group. productCatalogue/productGroups/products/externalIndicator Specifies the indicator for the product. productCatalogue/productGroups/products/productFeatures Specifies the various features of the products. productCatalogue/productGroups/products/productFeatures/sequenceNo Specifies the sequence number for the product feature. productCatalogue/productGroups/products/productFeatures/featureName Specifies the name of the feature. productCatalogue/productGroups/products/productFeatures/featureGroup Specifies the group to which the feature belongs. productCatalogue/productGroups/products/productFeatures/defaultValue Specifies the default value for the feature. productCatalogue/productGroups/products/productFeatures/optionDispType Specifies the display type for the option. productCatalogue/productGroups/products/productFeatures/description Specifies the description of the feature. productCatalogue/productGroups/products/productFeatures/type Specifies the type of the feature. productCatalogue/productGroups/products/productFeatures/isMandatory Specifies whether the feature is mandatory. productCatalogue/productGroups/products/productFeatures/extensionData Specifies the extension data that is associated with the feature. productCatalogue/productGroups/products/productFeatures/option Specifies the option that is provided by the feature. productCatalogue/productGroups/products/productFeatures/optionValues Specifies the option value details. productCatalogue/productGroups/products/productFeatures/optionValuesdescription Specifies the description of the option value. productCatalogue/productGroups/products/productFeatures/optionValues/value Specifies the value that is associated with the option. productCatalogue/productGroups/products/productFeatures/optionValues/extensionData Specifies the extension data that is associated with the option value. productCatalogue/productGroups/products/fees Specifies the fee details that are associated with the product. productCatalogue/productGroups/products/feesfeeAmount Specifies the fee amount. productCatalogue/productGroups/products/feesfeeFrequency Specifies the frequency at which the fee must be paid. productCatalogue/productGroups/products/amount Specifies the amount that must be paid for the product. productCatalogue/productGroups/products/productId Specifies the ID of the product. productCatalogue/productGroups/products/creditInterest Specifies the details about the type of interest, interest rate, minimum balance, and maximum balance. productCatalogue/productGroups/products/creditInterest/interestRate Specifies the interest rate. productCatalogue/productGroups/products/creditInterest/interestType Specifies the interest type for credit interest. productCatalogue/productGroups/products/creditInterest/interestMinimumBalance Specifies the minimum balance for the credit interest. productCatalogue/productGroups/products/creditInterest/interestMaximumBalance Specifies the maximum balance for the credit interest. productCatalogue/productGroups/products/imageDetails Specifies the image details of the products. productCatalogue/productGroups/products/maximumAmount Specifies the maximum amount for the product. productCatalogue/productGroups/products/overdraftAmount Specifies the overdraft amount for the product productCatalogue/productGroups/products/productName Specifies the product name. productCatalogue/productGroups/products/extensionData Specifies the extension data for the product. productCatalogue/productGroups/products/noticePeriod Specifies the notice period details in the payment. productCatalogue/productGroups/products/noticePeriod/weeks Specifies the number of weeks in the notice period. productCatalogue/productGroups/products/noticePeriod/months Specifies the number of months in the notice period. productCatalogue/productGroups/products/noticePeriod/days Specifies the number of days in the notice period. productCatalogue/productGroups/products/noticePeriod/years Specifies the number of years in the notice period. productCatalogue/productGroups/products/minimumAmount Specifies the minimum amount in the product. productCatalogue/productGroups/products/debitInterest Specifies the details about the type of interest, interest rate, minimum balance, and maximum balance. productCatalogue/productGroups/products/debitInterest/interestRate Specifies the interest rate. productCatalogue/productGroups/products/debitInterest/interestType Specifies the interest type for debit interest. productCatalogue/productGroups/products/debitInterest/interestMinimumBalance Specifies the minimum balance for debit interest. productCatalogue/productGroups/products/debitInterest/interestMaximumBalance Specifies the maximum balance for debit interest. productCatalogue/productGroups/products/term Specifies the term details for the product. productCatalogue/productGroups/products/term/weeks Specifies the number of weeks in the term. productCatalogue/productGroups/products/term/months Specifies the number of months in the term. productCatalogue/productGroups/products/term/days Specifies the number of days in the term. productCatalogue/productGroups/products/term/years Specifies the number of years in the term. productCatalogue/productGroups/products/currencyId Specifies the ID that is associated with a currency. productCatalogue/productGroups/products/productDescription Specifies the description of the products. productCatalogue/productGroups/products/status Specifies the status of the products. productCatalogue/extensionData Specifies the extension data that is associated with the product catalog. productCatalogue/productLineId Specifies the ID that is associated with the product line. View the Response Sample Code
{
"productCatalogue": [
{
"externalIndicator": "No",
"productLineDisplayName": "Lending products",
"productGroups": [
{
"externalIndicator": "N",
"detailDescription": "Saving Account Products",
"disclosure": "",
"imageDetails": [
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.png",
"width": 140,
"imageType": "Png",
"extensionData": {},
"height": 320
},
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.img",
"width": 140,
"imageType": "Banner",
"extensionData": {},
"height": 320
},
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.jpeg",
"width": 140,
"imageType": "JPEG",
"extensionData": {},
"height": 720
}
],
"productGroupId": "HOME.EQUITY",
"description": "Saving Account Products",
"productGroupDisplayName": "Home Equity products",
"extensionData": {},
"products": [
{
"externalIndicator": "No",
"productFeatures": [
{
"sequenceNo": 1,
"featureName": "Yes, I like to avail to Credit Card",
"featureGroup": "",
"defaultValue": "No",
"optionDispType": "CheckBox",
"description": "Using Credit card is fast and easy",
"type": "CreditCard",
"isMandatory": true,
"extensionData": {},
"option": "",
"optionValues": [
{
"description": "Opt-in",
"value": "OPT-IN",
"extensionData": {}
}
]
}
],
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"amount": 2000,
"productId": "HOME.EQUITY.LOAN",
"creditInterest": {
"interestRate": 10,
"interestType": "CREDIT",
"interestMinimumBalance": 5,
"interestMaximumBalance": 8
},
"imageDetails": [],
"maximumAmount": 500,
"overdraftAmount": 1000,
"productName": "Home Equity Loan",
"extensionData": {},
"noticePeriod": {
"weeks": 1,
"months": 4,
"days": 8,
"years": 1
},
"minimumAmount": 5,
"debitInterest": {
"interestRate": 10,
"interestType": "CREDIT",
"interestMinimumBalance": 5,
"interestMaximumBalance": 8
},
"term": {
"weeks": 4,
"months": 1,
"days": 8,
"years": 1
},
"currencyId": "USD",
"productDescription": "This is the description of the product",
"status": "Active"
}
]
}
],
"extensionData": {},
"productLineId": "LENDING"
},
|
| Error Code(s): |
None |
| Associated Enterprise APIs: | /ms-marketingcatalog-api/api/v1.0.0/product/products |
getProductGroupsByProductLine
| Description: |
This API fetches all the product groups in a product line. |
| Method: | GET |
| URL: | {base_url}/services/data/v1/BankProductManagment/operations/product/getProductGroupsByProductLine |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters productLine Specifies the product line to which the product belongs. |
| Response: |
View the Response Parameters
Parameters productGroups Specifies the various product groups and their details. productGroups/externalIndicator Specifies the indicator for the product groups. productGroups/detailDescription Specifies descriptions for the product detials. productGroups/disclosure Specifies the disclosure details of the product group. productGroups/imageDetails Specifies the image details of the products. productGroups/imageDetails/imageUrl Specifies the URL that is associated with the image. productGroups/imageDetails/width Specifies the width of the image. productGroups/imageDetails/imageType Specifies the type of the image. productGroups/imageDetails/extensionData Specifies the extension data that is associated with the image. productGroups/imageDetails/height Specifies the height of the image. productGroups/productGroupId Specifies the ID of the product group to which the products belong. productGroups/description Specifies the description of the product group. productGroups/productGroupDisplayName Specifies the name of the product group. productGroups/extensionData Specifies the extension data that is associated with the product group. View the Response Sample Code
{
"productGroups": [
{
"detailDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"externalIndicator": "N",
"disclosure": "",
"imageDetails": [
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.img",
"width": 140,
"imageType": "Banner",
"extensionData": {},
"height": 320
},
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.png",
"width": 140,
"imageType": "Png",
"extensionData": {},
"height": 320
},
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.png",
"width": 140,
"imageType": "JPEG",
"extensionData": {},
"height": 120
}
],
"productGroupId": "HOME.EQUITY",
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"productGroupDisplayName": "Home Equity products",
"extensionData": {}
}
]
}
|
| Error Code(s): | None |
| Associated Enterprise APIs: | <MicroService Host>/ms-marketingcatalog-api/api/v1.0.0/product/productLine/$PRODUCT_LINE/productGroup |
getProductsByProductGroup
| Description: | This API fetches the list of all products and marketing information details that belong to a product group. |
| Method: | GET |
| URL: | {base_url}/services/data/v1/BankProductManagment/operations/product/getProductsByProductGroup |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters productGroups (Mandatory) Specifies the product groups from which the products must be fetched. {
"productGroups": ""
}
|
| Response: |
View the Response Parameters
Parameters productCatalogue Specifies the details of the product catalog. productCatalogue/externalIndicator Specifies the indicator for the product catalog. productCatalogue/productLineDisplayName Specifies the name of the product line. productCatalogue/productGroups Specifies the various product groups and their details. productCatalogue/productGroups/externalIndicator Specifies the indicator for the product groups. productCatalogue/productGroups/detailDescription Specifies the descriptions of the product detials. productCatalogue/productGroups/disclosure Specifies the disclosure details of the product group. productCatalogue/productGroups/imageDetails Specifies the image details of the products. productCatalogue/productGroups/imageDetails/imageUrl Specifies the URL that is associated with the image. productCatalogue/productGroups/imageDetails/width Specifies the width of the image. productCatalogue/productGroups/imageDetails/imageType Specifies the type of the image. productCatalogue/productGroups/imageDetails/extensionData Specifies the extension data that is associated with the image. productCatalogue/productGroups/imageDetails/height Specifies the height of the image. productCatalogue/productGroups/productGroupId Specifies the ID of the product group to which the products belong. productCatalogue/productGroups/description Specifies the description of the product group. productCatalogue/productGroups/productGroupDisplayName Specifies the name of the product group. productCatalogue/productGroups/extensionData Specifies the extension data that is associated with the product group. productCatalogue/productGroups/products Specifies the list of products, with their details, that is present in a product group. productCatalogue/productGroups/products/externalIndicator Specifies the indicator for the product. productCatalogue/productGroups/products/productFeatures Specifes the various features of the products. productCatalogue/productGroups/products/productFeatures/sequenceNo Specifies the sequence number for the product feature. productCatalogue/productGroups/products/productFeatures/featureName Specifies the name of the feature. productCatalogue/productGroups/products/productFeatures/featureGroup Specifies the group to which the feature belongs. productCatalogue/productGroups/products/productFeatures/defaultValue Specifies the default value for the feature. productCatalogue/productGroups/products/productFeatures/optionDispType Specifies the display type for the option. productCatalogue/productGroups/products/productFeatures/description Specifies the description of the feature. productCatalogue/productGroups/products/productFeatures/type Specifies the type of the feature. productCatalogue/productGroups/products/productFeatures/isMandatory Specifies whether the feature is mandatory. productCatalogue/productGroups/products/productFeatures/extensionData Specifies the extension data that is associated with the feature. productCatalogue/productGroups/products/productFeatures/option Specifies the option that is provided by the feature. productCatalogue/productGroups/products/productFeatures/optionValues Specifies the option value details. productCatalogue/productGroups/products/productFeatures/optionValuesdescription Specifies the description of the option value. productCatalogue/productGroups/products/productFeatures/optionValues/value Specifies the value that is associated with the option. productCatalogue/productGroups/products/productFeatures/optionValues/extensionData Specifies the extension data that is associated with the option value. productCatalogue/productGroups/products/fees Specifies the fees that are associated with the product. productCatalogue/productGroups/products/feesfeeAmount Specifies the fee amount. productCatalogue/productGroups/products/feesfeeFrequency Specifies the frequency at which the fee must be paid. productCatalogue/productGroups/products/amount Specifies the amount that must be paid for the product. productCatalogue/productGroups/products/productId Specifies the ID of the product. productCatalogue/productGroups/products/creditInterest Specifies the details about the type of interest, interest rate, periodic index type. minimum balance, and maximum balance. productCatalogue/productGroups/products/creditInterest/interestRate Specifies the interest rate. productCatalogue/productGroups/products/creditInterest/periodicIndexType Specifies the periodic index type of the credit interest. productCatalogue/productGroups/products/creditInterest/interestType Specifies the interest type for credit interest. productCatalogue/productGroups/products/creditInterest/interestMinimumBalance Specifies the minimum balance for the credit interest. productCatalogue/productGroups/products/creditInterest/interestMaximumBalance Specifies the maximum balance for the credit interest. productCatalogue/productGroups/products/imageDetails Specifies the image details of the products. productCatalogue/productGroups/products/maximumAmount Specifies the maximum amount for the product. productCatalogue/productGroups/products/overdraftAmount Specifies the overdraft amount for the product productCatalogue/productGroups/products/productName Specifies the product name. productCatalogue/productGroups/products/extensionData Specifies the extension data for the product. productCatalogue/productGroups/products/noticePeriod Specifies the notice period details for the payment. productCatalogue/productGroups/products/noticePeriod/weeks Specifies the number of weeks in the notice period. productCatalogue/productGroups/products/noticePeriod/months Specifies the number of months in the notice period. productCatalogue/productGroups/products/noticePeriod/days Specfies the number of days in the notice period. productCatalogue/productGroups/products/noticePeriod/years Specifies the number of years in the notice period. productCatalogue/productGroups/products/prodDescription Specifies the product description details such as disclosure, notes, terms and conditions and so on. productCatalogue/productGroups/products/prodDescription/disclosure Specifies the disclosure details of the product. productCatalogue/productGroups/products/prodDescription/detailedDescription Specifies the detailed description of the product. productCatalogue/productGroups/products/prodDescription/notes Specifies the product notes. productCatalogue/productGroups/products/prodDescription/termsConditions Specifies the terms and conditions for the product. productCatalogue/productGroups/products/prodDescription/description Specifies a brief description of the product. productCatalogue/productGroups/products/prodDescription/extensionData Specifies the extension data that is associated with the product description. productCatalogue/productGroups/products/purposes Specifies the purpose of the product. productCatalogue/productGroups/products/minimumAmount Specifies the minimum amount for the product. productCatalogue/productGroups/products/debitInterest Specifies the details about the type of interest, interest rate, minimum balance, and maximum balance. productCatalogue/productGroups/products/debitInterest/interestRate Specifies the interest rate. productCatalogue/productGroups/products/debitInterest/periodicIndexType Specifies the periodic index type of the debit interest. productCatalogue/productGroups/products/debitInterest/interestType Specifies the interest type for debit interest. productCatalogue/productGroups/products/debitInterest/interestMinimumBalance Specifies the minimum balance for debit interest. productCatalogue/productGroups/products/debitInterest/interestMaximumBalance Specifies the maximum balance for debit interest. productCatalogue/productGroups/products/term Specifies the term details for the product. productCatalogue/productGroups/products/term/weeks Specifies the number of weeks in the term. productCatalogue/productGroups/products/term/months Specifies the number of months in the term. productCatalogue/productGroups/products/term/days Specifies the number of days in the term. productCatalogue/productGroups/products/term/years Specifies the number of years in the term. productCatalogue/productGroups/products/currencyId Specifies the ID that is associated with a currency. productCatalogue/productGroups/products/productDescription Specifies the description of the products. productCatalogue/productGroups/products/status Specifies the status for the products. productCatalogue/extensionData Specifies the extension data associated with the product catalog. productCatalogue/productLineId Specifies the ID that is associated with the product line. View the Response Sample Code
{
"productCatalogue": [
{
"externalIndicator": "N",
"productLineDisplayName": "Lending products",
"productGroups": [
{
"externalIndicator": "N",
"detailDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"disclosure": "",
"imageDetails": [
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.png",
"width": 140,
"imageType": "Png",
"extensionData": {},
"height": 320
},
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.png",
"width": 140,
"imageType": "JPEG",
"extensionData": {},
"height": 120
},
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.img",
"width": 140,
"imageType": "Banner",
"extensionData": {},
"height": 320
}
],
"productGroupId": "HOME.EQUITY",
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"productGroupDisplayName": "Home Equity products",
"extensionData": {},
"products": [
{
"externalIndicator": "N",
"productFeatures": [
{
"sequenceNo": 1,
"featureName": "",
"featureGroup": "",
"defaultValue": "",
"optionDispType": "",
"description": "",
"type": "eStatement",
"isMandatory": true,
"extensionData": {},
"option": "",
"optionValues": [
{
"description": "Opt-in",
"value": "Opt-in",
"extensionData": {}
}
]
},
{
"sequenceNo": 1,
"featureName": "I like to avail to Credit Card",
"featureGroup": "Card",
"defaultValue": "Yes",
"optionDispType": "SingleSelection",
"description": "Credit card is fast and easy",
"type": "CreditCard",
"isMandatory": true,
"extensionData": {},
"option": "",
"optionValues": [
{
"description": "Opt-in",
"value": "Opt-in",
"extensionData": {
"detailDesc": "Opted in for CreditCard"
}
},
{
"description": "Opt-in",
"value": "OPT-IN",
"extensionData": {}
}
]
}
],
"fees": {
"feeAmount": 500,
"feeFrequency": "DAILY"
},
"amount": 2000,
"productId": "HOME.EQUITY.LOAN",
"creditInterest": {
"interestRate": 10,
"periodicIndexType": "01",
"interestType": "CREDIT",
"interestMinimumBalance": 5,
"interestMaximumBalance": 8
},
"imageDetails": [
{
"imageUrl": "https://homepages.cae.wisc.edu/~ece533/images/airplane.png",
"width": 140,
"imageType": "JPEG",
"extensionData": {},
"height": 120
}
],
"maximumAmount": 500,
"overdraftAmount": 1000,
"productName": "Home Equity Loan",
"extensionData": {},
"noticePeriod": {
"weeks": 4,
"months": 1,
"days": 8,
"years": 1
},
"prodDescription": {
"disclosure": "",
"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": "",
"description": "A home equity loan, also known as a home equity installment loan or a second mortgage, is a type of consumer debt",
"extensionData": {}
},
"purposes": [
"string"
],
"minimumAmount": 5,
"debitInterest": {
"interestRate": 10,
"periodicIndexType": "01",
"interestType": "CREDIT",
"interestMinimumBalance": 5,
"interestMaximumBalance": 8
},
"term": {
"weeks": 4,
"months": 1,
"days": 8,
"years": 1
},
"currencyId": "INR",
"productDescription": "A home equity loan is a type of loan in which the borrower uses the equity of their home as collateral",
"status": "Active"
}
]
}
],
"extensionData": {},
"productLineId": "LENDING"
}
]
}
|
| Error Code(s): | None |
| Associated Enterprise APIs: | <Micro Service Host>/ms-marketingcatalog-api/api/v1.0.0/product/productGroups/$PRODUCT_GROUP |
GetProductsForPurpose
| Description: | This API fetches all the products that are used for a specific purpose. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/BankProductManagment/operations/product/GetProductsForPurpose |
| Security Level: | Authenticated App User |
| Header Request: | None |
| Body Request: |
Parameters Purpose Specifies the purpose for which the list of products must be fetched. {
"Purpose":"Onboarding"
}
|
| Response: |
View the Response Parameters
records[ ] A list that contains the details of various products. Parameters records/productId Specifies the ID of the product. records/Status_id Specifies the status of the product. records/productName Specifies the name of the product. records/productDescription Specifies the description of the product. records/productTypeId Specifies the ID of the group for which the product belongs. records/productType Specifies the name of the group for which the product belongs. View the Response Sample Code
{
"records": [
{
"productId": "SAVINGS.DEFAULT",
"Status_id": "Active",
"productName": "Salary Saving Account",
"productDescription": "Basic savings ideal for low balances and first-time savers",
"productTypeId": "SAVINGS.DEFAULT",
"productType": "Salary Saving Account"
},
{
"productId": "PREMIUM.ACCOUNT",
"Status_id": "Active",
"productName": "Preferred Checking Account",
"productDescription": "Everyday Checking, Banking made easy",
"productTypeId": "PREMIUM.ACCOUNT",
"productType": "Preferred Checking Account"
},
{
"productId": "PREFER.ACCOUNT",
"Status_id": "Active",
"productName": "Updated Advanced Current Account",
"productDescription": "Your checking account, Your way",
"productTypeId": "PREFER.ACCOUNT",
"productType": "Updated Advanced Current Account"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | None |
| Associated Enterprise APIs: | <MicroServiceHost>/ms-marketingcatalog-api/api/v2.0.0/product/purpose/Onboarding |
GetProducts
| Description: | This API allows the user to fetch the list of all the products and its details. | |||||
| Method: | GET | |||||
| URL: | /services/data/v1/BankProductManagment/operations/product/GetProducts | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: | X-Kony-Authorization | |||||
| Body Request: |
None |
|||||
| Response: |
View the Response Parameters
marketingCatalogue Specifies the details of the product catalog. marketingCatalogue/externalIndicator Specifies the indicator for the product catalog. marketingCatalogue/productLineRef Specifies the name of the product line. marketingCatalogue/productLineName Specifies the name of the product line. marketingCatalogue/productGroups Specifies the various product groups and their details. marketingCatalogue/productGroups/externalIndicator Specifies the indicator for the product groups. productCatalogue/productGroups/imageDetails Specifies the image details of the products. productCatalogue/productGroups/imageDetails/imageUrl Specifies the URL that is associated with the image. productCatalogue/productGroups/imageDetails/width Specifies the width of the image. productCatalogue/productGroups/imageDetails/imageType Specifies the type of the image. productCatalogue/productGroups/imageDetails/extensionData Specifies the extension data that is associated with the image. productCatalogue/productGroups/imageDetails/height Specifies the height of the image. productCatalogue/productGroups/productGroupId Specifies the ID of the product group to which the products belong. productCatalogue/productGroups/description Specifies a brief description of the product group. productCatalogue/productGroups/productGroupName Specifies the name of the product group. productCatalogue/productGroups/detailedDesc Specifies a detailed description of the product group. productCatalogue/productGroups/productGroupRef Specifies the reference number of the product group. productCatalogue/productGroups/branchRef Specifies the reference number of the branch of the product group. productCatalogue/productGroups/products Specifies the list of products, with their details, that is present in a product group. productCatalogue/productGroups/products/externalIndicator Specifies the indicator for the product. productCatalogue/productGroups/products/productFeatures Specifes the various features of the products. productCatalogue/productGroups/products/productFeatures/sequenceNo Specifies the sequence number for the product feature. productCatalogue/productGroups/products/productFeatures/featureName Specifies the name of the feature. productCatalogue/productGroups/products/productFeatures/featureGroup Specifies the group to which the feature belongs. productCatalogue/productGroups/products/productFeatures/defaultValue Specifies the default value for the feature. productCatalogue/productGroups/products/productFeatures/optionDispType Specifies the display type for the option. productCatalogue/productGroups/products/productFeatures/description Specifies the description of the feature. productCatalogue/productGroups/products/productFeatures/type Specifies the type of the feature. productCatalogue/productGroups/products/productFeatures/isMandatory Specifies whether the feature is mandatory. productCatalogue/productGroups/products/productFeatures/extensionData Specifies the extension data that is associated with the feature. productCatalogue/productGroups/products/productFeatures/option Specifies the option that is provided by the feature. productCatalogue/productGroups/products/productFeatures/optionValues Specifies the option value details. productCatalogue/productGroups/products/productFeatures/optionValuesdesc Specifies the description of the option value. productCatalogue/productGroups/products/productFeatures/optionValues/value Specifies the value that is associated with the option. productCatalogue/productGroups/products/productFeatures/optionValues/extensionData Specifies the extension data that is associated with the option value. productCatalogue/productGroups/products/apr productCatalogue/productGroups/products/productId Specifies the ID of the product. productCatalogue/productGroups/products/imageDetails Specifies the image details of the products. productCatalogue/productGroups/products/imageDetails/imageUrl Specifies the image details of the products. productCatalogue/productGroups/products/imageDetails/width Specifies the image details of the products. productCatalogue/productGroups/products/imageDetails/imageType Specifies the image details of the products. productCatalogue/productGroups/products/imageDetails/extensionData Specifies the image details of the products. productCatalogue/productGroups/products/imageDetails/height Specifies the image details of the products. productCatalogue/productGroups/products/productDetails Specifies an array of product details. productCatalogue/productGroups/products/productDetails/productDetailsId Specifies the unique ID of the product detail. productCatalogue/productGroups/products/productDetails/currency Specifies the currency code (Example: USD). productCatalogue/productGroups/products/productDetails/creditInterest Specifies an array of credit interest details such as interest rate, interest type, interest maximum balance, and interest minimum balance. productCatalogue/productGroups/products/productDetails/debitInterest Specifies an array of debit interest details such as interest rate, interest type, interest maximum balance, and interest minimum balance. productCatalogue/productGroups/products/availableFrom Specifies the starting date from when which the product is available. productCatalogue/productGroups/products/productName Specifies the product name. productCatalogue/productGroups/products/extensionData Specifies the extension data for the product. productCatalogue/productGroups/products/availableTo Specifies the ending date up to which the product is available. productCatalogue/productGroups/products/purposes Specifies the purpose of the product. productCatalogue/productGroups/products/productRef Specifies the reference number of the product. productCatalogue/productGroups/products/branchRef Specifies the reference number of the branch of the product. productCatalogue/productGroups/products/prodDescription Specifies the product description details such as disclosure, notes, terms and conditions and so on. productCatalogue/productGroups/products/prodDescription/disclosure Specifies the disclosure details of the product. productCatalogue/productGroups/products/prodDescription/detailedDescription Specifies the detailed description of the product. productCatalogue/productGroups/products/prodDescription/notes Specifies the product notes. productCatalogue/productGroups/products/prodDescription/termsConditions Specifies the terms and conditions for the product. productCatalogue/productGroups/products/prodDescription/description Specifies a brief description of the product. productCatalogue/productGroups/products/prodDescription/extensionData Specifies the extension data that is associated with the product description. productCatalogue/productGroups/products/status Specifies the status for the products. productCatalogue/productGroups/productLineId Specifies the ID that is associated with the product line. View the Response Sample Code
{
"opstatus": 0,
"httpStatusCode": 200,
"marketingCatalogue": [
{
"externalIndicator": false,
"productLineRef": "ACCOUNTS",
"productLineName": "Accounts",
"productGroups": [
{
"externalIndicator": false,
"imageDetails": [
{
"imageUrl": "landingpg2.png",
"width": 120,
"imageType": "Banner",
"extensionData": "{}",
"height": 720
}
],
"productGroupId": "PG20244AYVQ4",
"productGroupName": "Savings Accounts",
"description": "Savings account for all your needs",
"detailedDesc": "Our Savings Account is designed to fulfill your different needs in every stage of life",
"branchRef": "GB0010001",
"productGroupRef": "SAVINGS.ACCOUNTS",
"products": [
{
"externalIndicator": false,
"productFeatures": [
{
"sequenceNo": 1,
"featureName": "Yes, I like to avail to Debit Card",
"featureGroup": "",
"defaultValue": "OPT-OUT",
"optionDispType": "CheckBox",
"description": "desc",
"type": "CARD.ISSUE",
"isMandatory": false,
"extensionData": "{}",
"option": "",
"optionValues": [
{
"value": "OPT-OUT",
"extensionData": "{}",
"desc": ""
}
]
}
],
"apr": 0.53,
"productId": "PR20244CMMT4",
"imageDetails": [
{
"imageUrl": "banner.png",
"width": 120,
"imageType": "Banner",
"extensionData": {},
"height": 720
}
],
"productDetails": [
{
"productDetailsId": "PD20244UM07V",
"currency": "USD",
"debitInterests": [],
"creditInterests": []
}
],
"availableFrom": "2020-01-01",
"productName": "Prime Saving Account",
"extensionData": {},
"availableTo": "3020-01-01",
"purposes": [
"Onboarding"
],
"productRef": "SAVINGS.PRIME.INFINITY",
"branchRef": "GB0010001",
"productDescription": {
"disclosure": "disclosure",
"notes": "notes",
"termsConditions": "tandc",
"description": "desc",
"detailedDesc": "detailed desc",
"extensionData": "{}"
},
"status": "Active"
}
]
}
],
"productLineId": "PL20279C9SJY"
}
]
}
|
|||||
| Service Flow: |
|
createProduct
| Description: | This API allows the user to create a product. | |||||
| Method: | POST | |||||
| URL: | services/data/v1/BankProductManagment/operations/product/CreateProduct | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
|||||
| Body Request: |
View the Request Parameters
productName Specifies the name of the product. /externalIndicator Specifies the indicator for the product catalog. /productLine Specifies the name of the product line to which the product belongs. /productGroup Specifies the various product groups and their details. /productRef Specifies the reference number for the product. /branchRef Specifes the reference number for the branch of the product. /availableFrom Specifies the starting date from when which the product is available. /availableTo Specifies the ending date up to which the product is available. /purposes Specifies the purpose of the product. /description Specifies a brief description of the product group. /detailedDesc Specifies a detailed description of the product group. /notes Specifies the additional notes about the product. /termsAndConditions Specifies the terms and condition details. /disclosure Specifies the product disclosure details. /productFeatures/sequenceNo Specifies the sequence number for the product feature. /productFeatures/featureName Specifies the name of the feature. /productFeatures/featureGroup Specifies the group to which the feature belongs. /productFeatures/defaultValue Specifies the default value for the feature. /productFeatures/optionDispType Specifies the display type for the option. /productFeatures/description Specifies the description of the feature. /productFeatures/type Specifies the type of the feature. /productFeatures/isMandatory Specifies whether the feature is mandatory. /productFeatures/extensionData Specifies the extension data that is associated with the feature. /productFeatures/option Specifies the option that is provided by the feature. /productFeatures/optionValues Specifies the option value details. /productFeatures/optionValuesdesc Specifies the description of the option value. /productFeatures/optionValues/value Specifies the value that is associated with the option. /productFeatures/optionValues/extensionData Specifies the extension data that is associated with the option value. imageDetails Specifies the image details of the products. imageDetails/imageUrl Specifies the image details of the products. imageDetails/width Specifies the image details of the products. imageDetails/imageType Specifies the image details of the products. imageDetails/extensionData Specifies the image details of the products. imageDetails/height Specifies the image details of the products. /extensionData Specifies the extension data for the product. View the Request Sample Code
{
"productName": "test",
"productLine": "ref2",
"productGroup": "testGrp",
"productRef": "test123612",
"branchRef": "GB0010001",
"availableFrom": "2020-10-26",
"availableTo": "2023-10-25",
"purposes": [
{
"type": "Onboarding"
}
],
"description": "desc",
"detailedDesc": "desc",
"notes": "notes",
"termsConditions": "t and c",
"disclosure": "disc",
"productFeatures": [
{
"type": "e-Statement",
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"description": "desc",
"sequenceNo": 1432,
"isMandatory": true,
"defaultValue": "123",
"option": "",
"optionDispType": "SingleSelection",
"optionValues": [
{
"value": "123",
"desc": "",
"extensionData": {}
}
],
"extensionData": {}
}
],
"imageDetails": [
{
"imageType": "Banner",
"height": 556,
"width": 1366,
"imageUrl": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-autoloan-2x.png",
"extensionData": {}
}
],
"extensionData": []
}
|
|||||
| Response: |
Parameters /productID Specifies the unique ID of the product that has been created. /message Specifies the status message about the product. /status Specifies the status of the operation. {
"productId": "PR20281MN4CZ",
"opstatus": 0,
"message": "",
"status": "Success",
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
updateProduct
| Description: | This API allows the user to update the product details. | |||||
| Method: | PUT | |||||
| URL: | /services/data/v1/BankProductManagment/operations/product/UpdateProduct | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
|||||
| Body Request: |
View the Request Parameters
productName Specifies the name of the product. /productLine Specifies the name of the product line to which the product belongs. /productGroup Specifies the various product groups and their details. /productRef Specifies the reference number for the product. /branchRef Specifes the reference number for the branch of the product. /availableFrom Specifies the starting date from when which the product is available. /availableTo Specifies the ending date up to which the product is available. /purposes Specifies the purpose of the product. /description Specifies a brief description of the product group. /detailedDesc Specifies a detailed description of the product group. /notes Specifies the additional notes about the product. /termsAndConditions Specifies the terms and condition details. /disclosure Specifies the product disclosure details. /productFeatures/sequenceNo Specifies the sequence number for the product feature. /productFeatures/featureName Specifies the name of the feature. /productFeatures/featureGroup Specifies the group to which the feature belongs. /productFeatures/defaultValue Specifies the default value for the feature. /productFeatures/optionDispType Specifies the display type for the option. /productFeatures/description Specifies the description of the feature. /productFeatures/type Specifies the type of the feature. /productFeatures/isMandatory Specifies whether the feature is mandatory. /productFeatures/extensionData Specifies the extension data that is associated with the feature. /productFeatures/option Specifies the option that is provided by the feature. /productFeatures/optionValues Specifies the option value details. /productFeatures/optionValuesdesc Specifies the description of the option value. /productFeatures/optionValues/value Specifies the value that is associated with the option. /productFeatures/optionValues/extensionData Specifies the extension data that is associated with the option value. imageDetails Specifies the image details of the products. imageDetails/imageUrl Specifies the image details of the products. imageDetails/width Specifies the image details of the products. imageDetails/imageType Specifies the image details of the products. imageDetails/extensionData Specifies the image details of the products. imageDetails/height Specifies the image details of the products. /extensionData Specifies the extension data for the product. View the Request Sample Code
{
"productName": "Updated Name",
"productLine": "ACCOUNTS",
"productGroup": "CURRENT.ACCOUNTS",
"productRef": "ADVANCED.CHECKING.ACCOUNT",
"branchRef": "GB0010001",
"availableFrom": "2020-01-01",
"availableTo": "2048-10-21",
"purposes": [
{
"type": "Onboarding"
}
],
"description": "desc",
"detailedDesc": "detailed desc",
"notes": "notes",
"termsConditions": "t and c",
"disclosure": "disc",
"productFeatures": [],
"imageDetails": [
{
"imageType": "Banner",
"height": 556,
"width": 1366,
"imageUrl": "https://banner.png",
"extensionData": {}
}
],
"extensionData": []
}
|
|||||
| Response: |
Parameters /productID Specifies the unique ID of the product that has been created. /message Specifies the status message about the product. /status Specifies the status of the operation. {
"productId": "PR20281MN4CZ",
"opstatus": 0,
"message": "",
"status": "Success",
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
GetFeatures
| Description: | This API allows the user to fetch all the features. | |||||
| Method: | GET | |||||
| URL: | /services/data/v1/BankProductManagment/operations/product/GetFeatures | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
|||||
| Body Request: |
None |
|||||
| Response: |
Parameters /FeatureType Specifies an array of Feature type JSON Object. /FeatureType/featureName Specifies the name of the feature. /FeatureType/featureGroup Specifies the name of the group to which the feature belongs. /FeatureType/featureType Specifies the type of the feature. /FeatureType/detailedDesc Specifies the detailed description of the feature. {
"FeatureType": [
{
"featureName": "Electronic Statement",
"featureGroup": "Statement",
"featureType": "e-Statement",
"detailedDesc": "Electronic Statement will be automatically sent for the product when opted in for this feature"
}
]
}
|
|||||
| Service Flow: |
|
CreateFeature
| Description: | This API allows the user to create a feature. | |||||
| Method: | POST | |||||
| URL: | services/data/v1/BankProductManagment/operations/product/CreateFeature | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
|||||
| Body Request: |
Parameters featureName Specifies the name of the feature. featureGroup Specifies the name of the group to which the feature belongs. featureType Specifies the type of the feature. detailedDesc Specifies the detailed description of the feature. {
"featureType": "sample feature type ",
"featureName": "test",
"featureGroup": "sample group",
"detailedDesc": "test"
}
|
|||||
| Response: |
Parameters /referenceType Specifies the type of reference that the user has created. /message Specifies the status message about the product. /status Specifies the status of the operation. {
"referenceType": "FeatureType",
"opstatus": 0,
"message": "FeatureType created successfully",
"status": "Success",
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
UpdateFeature
| Description: | This API allows the user to update the feature and feature details. | |||||
| Method: | PUT | |||||
| URL: | /services/data/v1/BankProductManagment/operations/product/UpdateFeature | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
|||||
| Body Request: |
Parameters featureName Specifies the name of the feature. featureGroup Specifies the name of the group to which the feature belongs. featureType Specifies the type of the feature. detailedDesc Specifies the detailed description of the feature. {
"featureType": "CreditCard",
"featureName": "Credit Card Name ",
"featureGroup": "Card type",
"detailedDesc": "test"
}
|
|||||
| Response: |
Parameters /referenceType Specifies the type of reference that the user has created. /message Specifies the status message about the product. /status Specifies the status of the operation. {
"referenceType": "FeatureType",
"opstatus": 0,
"message": "FeatureType updated successfully",
"status": "Success",
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
Get Product Lines
| Description: | This API is used to fetch product lines. | ||||
| Method: | GET | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/GetProductLines | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: | <X-Kony-Authorization • X-Kony-ReportingParams> | ||||
| Body Request: |
None |
||||
| Response: |
Parameters productLines productLines/productLineRef Specifies the reference of the product line productLines/productLineName Specifies the name of the product line productLines/productLineId Specifies the ID of the product line
{
"productLines": [{
"productLineRef": "ACCOUNTS",
"productLineName": "Accounts",
"productLineId": "PL20244ZPE1Q"
}]
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
Create Product Lines
| Description: | This API is used to create product lines. | ||||
| Method: | POST | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/CreateProductLines | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters productLineName Specifies the name of the Product line productLineRef Specifies the reference of the Product Group {
"productLineName": "Test",
"productLineRef": "Testwqar"
}
|
||||
| Response: |
Parameters referenceType Specifies the reference Type of the Product message Specifies the Success or Failure message status Specifies the status of the creation of the product line {
"referenceType": "ProductLine",
"opstatus": 0,
"message": "ProductLine created successfully",
"status": "Success",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
Update Product Lines
| Description: | This API is used to update product lines. | ||||
| Method: | PUT | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/UpdateProductLines | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters productLineName Specifies the name of the product line productLineRef Specifies the reference of the product group {
"productLineName": "Test",
"productLineRef": "Testwqar"
}
|
||||
| Response: |
Parameters referenceType Specifies the reference Type of the Product message Specifies the Success or Failure message status Specifies the status of the creation of the product line {
"referenceType": "ProductLine",
"opstatus": 0,
"message": "ProductLine created successfully",
"status": "Success",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
Get Product Groups
| Description: | This API is used to fetch all the product groups. | ||||
| Method: | GET | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/GetProductGroups | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
None |
||||
| Response: |
Parameters productGroups productGroups/productLineRef Specifies the reference of the Product Line of which product group belongs to productGroups/imageDetails productGroups/imageDetails/imageURL Specifies the URL of the image productGroups/imageDetails/width Specifies the width of the image productGroups/imageDetails/imageType Specifies the type of the image productGroups/imageDetails/height Specifies the height of the image productGroups/productGroupId Specifies the ID of the Product Group productGroups/productGroupName Specifies the name of the Product Group productGroups/description Specifies the description of the Product Group productGroups/detailedDesc Specifies the detailed description of the Product Group productGroups/productGroupRef Specifies the reference of the Product Group productGroups/productLineId Specifies the ID of the Product Line {
"opstatus": 0,
"productGroups": [
{
"productLineRef": "ACCOUNTS",
"imageDetails": [
{
"imageUrl": "landingpg2.png",
"width": 120,
"imageType": "Banner",
"height": 720
}
],
"productGroupId": "PG20244AYVQ4",
"productGroupName": "Savings Accounts",
"description": "Savings account for all your needs",
"detailedDesc": "Our Savings Account is designed to fulfill your different needs in every stage of life",
"productGroupRef": "SAVINGS.ACCOUNTS",
"productLineId": "PL20244ZPE1Q"
}
]
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
Create Product Groups
| Description: | This API is used to create Product Groups. | ||||
| Method: | POST | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/CreateProductGroups | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters productLineRef Specifies the reference of the product group productGroupRef Specifies the reference of the Product Group productGroupName Specifies the name of the Product Group detailedDesc Specifies the detailed description of the product group description Specifies the description of the Product imageDetails imageDetails/imageType Specifies the type of the image imageDetails/height Specifies the height of the image imageDetails/width Specifies the width of the image imageDetails/imageUrl Specifies the URL of the image {
"productLineRef": "ACCOUNTS",
"productGroupRef": "Test Ref",
"productGroupName": "Test Product Group",
"detailedDesc": "desc",
"description": "desc",
"imageDetails": [
{
"imageType": "Icon",
"height": 40,
"width": 40,
"imageUrl": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-autoloan-2x.png"
}
]
}
|
||||
| Response: |
Parameters referenceType Specifies the reference Type of the Product message Specifies the Success or Failure message status Specifies the status of the creation of the product {
"code": "",
"referenceType": "ProductGroup",
"opstatus": 0,
"message": "",
"status": "Success",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
Update Product Groups
| Description: | This API is used to update Product Groups. | ||||
| Method: | PUT | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/UpdateProductGroups | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters productLineRef Specifies the reference of the product group productGroupRef Specifies the reference of the Product Group productGroupName Specifies the name of the Product Group detailedDesc Specifies the detailed description of the product group description Specifies the description of the Product imageDetails imageDetails/imageType Specifies the type of the image imageDetails/height Specifies the height of the image imageDetails/width Specifies the width of the image imageDetails/imageUrl Specifies the URL of the image {
"productLineRef": "ACCOUNTS",
"productGroupRef": "Test Ref",
"productGroupName": "Test Product Group",
"detailedDesc": "desc",
"description": "desc",
"imageDetails": [
{
"imageType": "Icon",
"height": 40,
"width": 40,
"imageUrl": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-autoloan-2x.png"
}
]
}
|
||||
| Response: |
Parameters referenceType Specifies the reference Type of the Product message Specifies the Success or Failure message status Specifies the status of the creation of the product line {
"code": "",
"referenceType": "ProductGroup",
"opstatus": 0,
"message": "",
"status": "Success",
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
GetAllProductGroups
| Description: | This API is used to fetch all the product groups for purpose as Campaign . | ||||
| Method: | GET | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/GetAllProductGroups | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
None |
||||
| Response: |
Parameters productGroups productGroups/productGroupId Specifies the ID of the Product Group productGroups/productGroupName Specifies the name of the Product Group {
"opstatus": 0,
"productGroups": [
{
"productGroupId": "CURRENT.ACCOUNTS",
"productGroupName": "Current Accounts"
}
],
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
GetProducts By product Group
| Description: | API is used to fetch the products for the specific product group | ||||
| Method: | GET | ||||
| URL: | /services/data/v1/BankProductManagment/operations/product/getProductsByProductGroup | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: |
|
||||
| Body Request: |
Parameters productGroups productGroups/productGroupId {
"productGroups":"CURRENT.ACCOUNTS"
}
|
||||
| Response: |
Parameters items items/productGroupId Specifies the ID of the group items/productGroupDisplayName Specifies the display name of the product group items/products items/products/productId Specifies the ID of the product items/products/productName Specifies the name of the product
{
"opstatus": 0,
"items": {
"productGroupId": "CURRENT.ACCOUNTS",
"productGroupDisplayName": "Current Accounts",
"products": [
{
"productId": "PR20244WO3UU",
"productName": "Advanced Checking Account EDIt"
}
]
},
"httpStatusCode": 200
}
|
||||
| Error Code(s): |
None |
||||
| Service Flow: |
|
In this topic