Dashboard Products Management

Name Description Introduced In
getDetails This API allows to retrieve Collateral details from ODMS. 2021.01
getProductGroupsWithPurpose This API retrieves the list of product groups based on the purpose. The product groups are displayed as cards on the landing page and the hamburger menu. 2021.01
getProductsFromProductGroup This API retrieves the list of products that are part of a product group. The list is displayed on the frmProductGroup page. 2021.01
getLoanSimulationDetails This API retrieves Loan simulation details to calculate loan amount with interest rate. 2021.01
getEligibleAmount This API allows to retrieve the calculated eligible Amount 2022.04
ClosedgetDetails
 
Description: Retrieves the collateral details of the product that is selected, when the Learn More (product group page) onClick action is triggered. The API populates the response on the frmProductDetails page.
Method: getCollateral
URL: {{baseUrl}}/services/data/v1/DashboardProductsSelectionManagement/operations/Collateral/getDetails
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request: 
   {} //no input. handled from session
Response:
ClosedView the Response Sample Code 
{
    "CurrencyId" : "USD",
    "ID": "61a5ad6da63a382b3a7f0a8a",
    "PropertyIdentified" :true,
    "PropertyDetails": {
      "PropertyType": "Individual House",
      "PropertySubType": "Re-Sale",
      "Furnished": "Fully Furnished",
      "PropertyStatus": "",
      "PropertyAge": 2, 
      "ConstructionCompletionDate":"",
      "ExpectedConstructionCompletionDate": "",
      "PropertyUsage": "Self-Occupied",
      "PlotNo": "901",
      "Size": 1200,
      "NoOfFloors": 20,
      "BuiltUpArea": 1200,
      "SellerName": "AMCO International Costructions",
      "CostOfProperty": 100000
    },
    "PropertyAddress": {
      "PropertyName": "", 
      "DoorNo": 502,  
      "FloorNo": "",   
      "AddressLine1": "9225 Bee Cave Road",
      "AddressLine2": "300",
      "City": "Austin",
      "State": "US-TX",
      "Country": "US",
      "Zipcode": "78733"
    },
    "opstatus": 0,
    "httpStatusCode": 200
}
Error Code(s):

  • Error Code: 75620

  • Error Message: Unable to retrieve Collateral details

Service Flow:
Integration Services Backend Services
GetCollateralOperation

Java Class: GetCollateralOperation (com.temenos.onboarding.product.javaservice.GetCollateralOperation)
ClosedgetProductGroupsWithPurpose
 
Description: This API retrieves the list of product groups based on the purpose. The product groups are displayed as cards on the landing page and the hamburger menu.
Method: POST
URL: {baseUrl}/services/data/v1/DashboardProductsManagement/operations/Product/getProductGroupsWithPurpose
Security Level: Authenticated App Users
Header Request:
  • X-Kony-Authorization
Body Request: 
{
    "Purpose": "Onboarding",
    "BranchRef": "GB0010001"
}
Response: 
Click here for response
Error Code(s):

None
Service Flow:
Integration Services Backend Services
getProductsForPurpose
  • getProductsForPurpose
    • Version Number: V 2.0.0
    • Method: GET
    • URL: /product/products/purpose/Onboarding
    • Storage Name: Market Catalog MS
ClosedgetProductsFromProductGroup
 
Description: Retrieves the list of products that are part of a product group. The list is displayed on the frmProductGroup page.
Method: POST
URL: {{baseUrl}}/services/data/v1/DashboardProductsManagement/operations/Product/getProductsFromProductGroup
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

Purpose (Mandatory)

Specifies the purpose that is fetched from the Spotlight app.

ProductGroupID (Mandatory)

Specifies the ID of the product group that must be fetched.

{
  "Purpose": "",
  "ProductGroupID": "SAVINGS.ACCOUNTS"
}
Response:

Parameters

ClosedView the Response Parameters

/ProductDashboard

Specifies the product dashboard details.

/ProductDashboard/ProductGroups

Specifies the product groups that are present in the dashboard.

/ProductDashboard/ProductGroups/productGroupId

Specifies the ID that is associated with the Product group.

/ProductDashboard/ProductGroups/productGroupDisplayName

Specifies the display name of the product group.

/ProductDashboard/ProductGroups/description

Specifies a brief description about the product group.

/ProductDashboard/ProductGroups/externalIndicator

Specifies the external indicator of the product group.

/ProductDashboard/ProductGroups/detailDescription

Specifies a detailed description about the product group.

/ProductDashboard/ProductGroups/disclosure

Specifies the disclosure details of the product group.

/ProductDashboard/ProductGroups/imageDetails

Specifies the various details of the images in the product group, such as image type, height, and extension data.

/ProductDashboard/ProductGroups/imageDetails/imageType

Specifies the type of the image.

/ProductDashboard/ProductGroups/imageDetails/height

Specifies the height of the image

/ProductDashboard/ProductGroups/imageDetails/extensionData

<Specifies the extension data that is associated with the image.

/ProductDashboard/products

Specifies various product details such as ID, currency ID, and so on.

/ProductDashboard/products/productId

Specifies the ID of the product.

/ProductDashboard/products/currencyId

Specifies the ID of the currency.

/ProductDashboard/products/minimumAmount

Specifies the minimum amount of the product.

/ProductDashboard/products/status

Specifies the status of the availability of the products.

/ProductDashboard/products/externalIndicator

Specifies the external indicator of the product.

/ProductDashboard/products/productDescription

Specifies the description of the product.

/ProductDashboard/products/prodDescription

Specifes the details of the product description.

/ProductDashboard/products/prodDescription/description

Specifies the brief description about the product.

/ProductDashboard/products/prodDescription/detailedDescription

Specifies a detailed description about the product.

/ProductDashboard/products/prodDescription/notes

Specifies certain notes about the product.

/ProductDashboard/products/prodDescription/termsConditions

Specifies certain terms and conditions that are associated with thh product.

/ProductDashboard/products/prodDescription/disclosure

Specifies the disclosure details about the product.

/ProductDashboard/products/prodDescription/extensionData

Specifies the extension data that is associated with the product.

/ProductDashboard/products/productFeatures

Specifies the feature details of the product.

/ProductDashboard/products/productFeatures/type

Specifies the type of product feature.

/ProductDashboard/products/productFeatures/description

Specifies the description about the product feature.

/ProductDashboard/products/productFeatures/featureName

Specifies the name of the feature.

/ProductDashboard/products/productFeatures/featureGroup

Specifies the name of the group to which the feature belongs.

/ProductDashboard/products/productFeatures/sequenceNo

Specifies the sequence number of the product feature.

/ProductDashboard/products/productFeatures/option

Specifies the options that are provided by the feature.

/ProductDashboard/products/productFeatures/optionDispType

Specifies the display type of the option.

/ProductDashboard/products/productFeatures/optionValues

Specifies the various values that are associated with the option.

/ProductDashboard/products/productFeatures/extensionData

Specifies the extension data that is associated with the product.

/ProductDashboard/products/ProductGroups/imageDetails

Specifies the image details of the products that are present in a product group.

/ProductDashboard/products/imageDetails/imageType

Specifies the type of the image.

/ProductDashboard/products/imageDetails/height

Specifies the height of the image.

/ProductDashboard/products/imageDetails/extensionData

Specifies the extension data that is associated with the image.

/ProductDashboard/products/extensionData

Specifies the extension data that is associated with the product.

ClosedView the Response Sample Code 
{
    "ProductDashboard":[
    {
        "ProductGroups":"[
        {
            "productGroupId":"SAVINGS.ACCOUNTS",
            "productGroupDisplayName":"Savings Accounts",
            "description":"",
            "externalIndicator":"N",
            "detailDescription":"",
            "disclosure":"testing",
            "imageDetails":[
            {
                "imageType":"BannerImage",
                "height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/savings_account.png",
                "extensionData":
                {
                    
                }

            }
],"products":[
            {
                "productId":"INCOME.ACCOUNT",
                "currencyId":"USD",
                "minimumAmount":2000,"purposes":["Onboarding"],"productName":"Standard Saving Account",
                "status":"Active",
                "externalIndicator":"",
                "productDescription":"",
                "prodDescription":
                {
                    "description":"Empowering with financial independence and simplified banking",
                    "detailedDescription":"The Standard Savings Account simplifies banking for the independent women of today. Benefits of the Women\\u2019s Savings Account include low opening deposit and attractive interest rate",
                    "notes":"",
                    "termsConditions":"test",
                    "disclosure":"testing",
                    "extensionData":
                    {
                        
                    }

                }
,"productFeatures":[
                {
                    "type":"Cheque Book",
                    "description":"You can use a cheque to withdraw cash, pay for service, or transfer money to another account. You can write a cheque to yourself or a bearer for cash transactions or to a company or person, who can deposit it in their bank and receive the money in their account",
                    "featureName":"Yes, I like to order a cheque book",
                    "featureGroup":"",
                    "sequenceNo":3,"isMandatory":false,"defaultValue":"No",
                    "option":"",
                    "optionDispType":"CheckBox",
                    "optionValues":[],"extensionData":
                    {
                        
                    }

                }
],"imageDetails":[
                {
                    "imageType":"Banner",
                    "height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
                    "extensionData":
                    {
                        
                    }

                }
],"extensionData":
                {
                    
                }

            }
,
            {
                "productId":"STAFF.ACCOUNT",
                "currencyId":"USD",
                "minimumAmount":2500,"purposes":["Onboarding"],"productName":"Prime Saving Account",
                "status":"Active",
                "externalIndicator":"",
                "productDescription":"",
                "prodDescription":
                {
                    "description":"Get the advantage of enhanced access and higher transaction limits",
                    "detailedDescription":"Prime Savings Account gives you an edge in the way you bank. Benefits of the Prime Savings Account include enhanced transaction limits and free checkbooks",
                    "notes":"",
                    "termsConditions":"test",
                    "disclosure":"testing",
                    "extensionData":
                    {
                        
                    }

                }
,"productFeatures":[
                {
                    "type":"Debit Card",
                    "description":"Carry your bank account safely wherever you go with the Debit card. And Do a lot more with your Debit Card!!",
                    "featureName":"Yes, I like to avail to Debit Card",
                    "featureGroup":"",
                    "sequenceNo":1,"isMandatory":false,"defaultValue":"No",
                    "option":"",
                    "optionDispType":"CheckBox",
                    "optionValues":[],"extensionData":
                    {
                        
                    }

                }
],"imageDetails":[
                {
                    "imageType":"Banner",
                    "height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
                    "extensionData":
                    {
                        
                    }

                }
],"extensionData":
                {
                    
                }

            }
,
            {
                "productId":"SAVINGS.DEFAULT",
                "currencyId":"USD",
                "minimumAmount":150,"purposes":["Onboarding"],"productName":"Salary Saving Account",
                "status":"Active",
                "externalIndicator":"",
                "productDescription":"",
                "prodDescription":
                {
                    "description":"Basic savings ideal for low balances and first-time savers",
                    "detailedDescription":"Savings Account is uniquely design for you to achieve your financial goals. We provide the optimum solution for you to manage your money efficiently",
                    "notes":"",
                    "termsConditions":"test",
                    "disclosure":"testing",
                    "extensionData":
                    {
                        
                    }

                }
,"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":[],"extensionData":
                    {
                        
                    }

                }
,
                {
                    "type":"Debit Card",
                    "description":"Using Debit card is fast and easy. Access your funds 24\\/7 and make purchases at millions of locations worldwide",
                    "featureName":"Yes, I like to avail to Debit Card",
                    "featureGroup":"",
                    "sequenceNo":1,"isMandatory":false,"defaultValue":"No",
                    "option":"",
                    "optionDispType":"CheckBox",
                    "optionValues":[],"extensionData":
                    {
                        
                    }

                }
],"imageDetails":[
                {
                    "imageType":"Banner",
                    "height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
                    "extensionData":
                    {
                        
                    }

                }
],"extensionData":
                {
                    
                }

            }
],"extensionData":
            {
                
            }

        }
]",
        "Products":"
        {
            productId=INCOME.ACCOUNT, currencyId=USD, minimumAmount=2000, purposes=["Onboarding"], productName=Standard Saving Account, status=Active, externalIndicator=, productDescription=, prodDescription=
            {
                description=Empowering with financial independence and simplified banking, detailedDescription=The Standard Savings Account simplifies banking for the independent women of today. Benefits of the Women’s Savings Account include low opening deposit and attractive interest rate, notes=, termsConditions=test, disclosure=testing, extensionData=
                {
                    
                }

            }
, productFeatures=[
            {
                "type":"Cheque Book",
                "description":"You can use a cheque to withdraw cash, pay for service, or transfer money to another account. You can write a cheque to yourself or a bearer for cash transactions or to a company or person, who can deposit it in their bank and receive the money in their account",
                "featureName":"Yes, I like to order a cheque book",
                "featureGroup":"",
                "sequenceNo":3,"isMandatory":false,"defaultValue":"No",
                "option":"",
                "optionDispType":"CheckBox",
                "optionValues":[],"extensionData":
                {
                    
                }

            }
], imageDetails=[
            {
                "imageType":"Banner",
                "height":720,"width":120,"imageUrl":"https:\\/\\/marketingcatalog.microservice.temenos.com\\/resources\\/images\\/deposit_threeyear_fd.png",
                "extensionData":
                {
                    
                }

            }
], extensionData=
            {
                
            }

        }
"
    }
],"opstatus":0,"httpStatusCode":200
}
Error Code(s):

  • Error Code: 8009
    Error Message: Backend request failed for service getProductsFromProductGroup5980 with HTTP status code 400.
Service Flow:
Integration Services Backend Services
getProductsFromProductGroup
  • getProductsInProductGroup
    • Version Number: V 2.0.0
    • Method: GET
    • URL: /product/products/productCatalogue?productGroupIds={ProductGroupID}&purposes=Onboarding
    • Storage Name: Market Catalog
ClosedgetLoanSimulationDetails
 
Description: This API retrieves Loan simulation details to calculate loan amount with interest rate.
Method: POST
URL: {{baseUrl}}/services/data/v1/DashboardProductsManagement/operations/LoanSimulation/getLoanSimulationDetails
Security Level: Anonymous App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

productId

Specifies the unique ID of the product.

currencyId

Specifies the ID of currency.

branchRef

Specifies the branch reference number.

principalAmount

Specifies the total loan amount.

term

Specifies the duration in months.

group

Specifies in which group this to be added

{
    "productId": "PERSONAL.LOAN",
    "currencyId": "USD",
    "branchRef": "GB0010001",
    "principalAmount": "100000",
    "term": "24",
    "group": "Onboarding"
}
Response: 
Responce
{
	"opstatus": 0,
	"httpStatusCode": 200,
	"interestDetails": [{
	"rate": 2.63225,
	"startDate": "Fri Jul 16 00:00:00 UTC 2021"
	}],
	"apr": 2.0184,
	"charges": [],
	"totalPrincipal ": "100000",
	"monthlyPayment": 4247.113,

	"currency": "USD",
	"term": "24",
	"repaymentDetails": {
	"repaymentStartDate": "Fri Jul 16 00:00:00 UTC 2021",
	"repaymentEndDate": "Fri Jun 16 00:00:00 UTC 2023"
	},
	"paymentFrequency": "e0Y e1M e0W e0D e0F"

	
}
Error Code(s):

  • Error Code: 79305
    Error Message: Get loan simulation failed.
Service Flow:
Integration Services Backend Services
OnBoardingJavaServices - GetLoanSimulationDetailsOperation

getLoanSimulation

Storage Name: Marketing Catalogue MS
   
ClosedgetEligibleAmount
 
Description: This API allows to get the Maximum Eligible Loan amount.
Method: getEligibleAmount
URL: {{baseurl}}/services/data/v1/DashboardProductsManagement/operations/MortgageSimulation/getEligibleAmount
Security Level: Anonymous App User
Header Request: POST
Body Request:

Parameters

productId

Specifies the unique ID of the product.

currencyId

Specifies the ID of currency.

branchRef

Specifies the branch reference number.

principalAmount

Specifies the total loan amount.

term

Specifies the duration in months.

group

Specifies in which group this to be added

{
"totalPropertyCost": 17000,

"dobApplicant": "1970-01-01",

"dobCoApplicant": "",

"monthlyGross": 242353,

"monthlyDebt": 34,

"interestRate": "5",

"purpose": "First time buyer"

}
Response: 
{
	"maximumEligibleAmount": "15300",
"maximumTerm": "17",
"propertyCost": "17000",
"opstatus": 0,
"httpStatusCode": 200
	}
Error Code(s):
  • Error Code: 81103
  • Error Message: Failed to get LoanAmount and maximumAllowedRepaymentTerm
Service Flow:
Integration Services: GetMortgageSimulationOperation Backend Services
ODMS

 
   
Expand/Collapse
Share
Print

In this topic

Copyright © 2020- Temenos Headquarters SA

Published on :
Monday, May 2, 2022 5:52:04 PM IST

Feedback
x