Products Selection Management
Name | Description | Introduced In |
---|---|---|
getDetails | This API allows to retrieve Collateral details from ODMS. | 2021.01 |
getAllCDPlans | Retrieves all the Certificate of Deposit plans that are associated with a product. The Certificate of Deposit plans are generated based on the amount range and time period. | 2021.01 |
getProductsForPurpose | Retrieves the list of products from the Marketing Catalog microservice based on the specified purpose. | 2021.01 |
updateProductSelection | Updates the selected products in the Origination Data Microservice (ODMS); and the Product IDs in Temenos Digital. | 2021.01 |
getProductSelection | Retrieves all the selected products from the Origination Data Microservice (ODMS). | 2021.01 |
updateDetails | This API allows to create/update Collateral details in ODMS. | 2022.01 |
generateDocument | This API allows to generate the document. | 2022.04 |
updatePaymentSchedule | This API allows to update the schedule data in ODMS. | 2022.04 |
getOPMSDetails | This API is used to fetch the collaterals associated to the partyId | 2023.01 |

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: |
![]() { "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): |
"dbpErrCode": "75620", "opstatus": 0, "dbpErrMsg": "Unable to retrieve Collateral details", "httpStatusCode": 200 |
||||
Service Flow: |
|

Description: | The API is used to fetch the collaterals associated to the partyId. | ||||
Method: | GET | ||||
URL: | {{baseUrl}}/services/data/v1/ProductsSelectionManagement/operations/Collateral/getOPMSDetails | ||||
Security Level: | Authenticated App Users | ||||
Header Request: |
X-Kony-Authorization |
||||
Body Request: | {“partyId”:”23097690”(Mandatory)} |
||||
Response: |
![]() { "collaterals":[ { "externalReferenceId":"", "collateralDueDiligence": { "coverageAmount":"", "agentPhone":"", "deductableAmountCurrency":"", "agentEmail":"", "personalInjuryCoverageAmount":"", "policyNumber":"", "valuations":[ { "valuationDate":"21/11/2022", "valuationDocumentName":"", "valuationSource":"", "valuationValueCurrency":"USD", "valuationDocumentId":"", "valuationValue":"100000", "extensionData": { } } ],"agentName":"", "deductableAmount":"", "collisionCoverageAmount":"", "additionalInsured":"", "liabiltyCoverageAmount":"", "registrationExpiryDate":"", "otherDueDiligence":[],"registrationLocation":"", "policyType":"", "registration":"", "nextValuationDate":"", "coverageAmountCurrency":"", "insuranceCompany":"", "requiredCoverage":"", "expirationDate":"" } ,"collateralDetail": { "propertyAge":"", "country":"IN", "newOrUsed":"", "furnishedType":"", "occupancy":"", "year":"", "documentNumber":"", "propertySubType":"02", "usage":"", "postalCode":"123213", "mortgageRegistrationNumber":"", "insuredCustomer":"", "policyNumber":"", "stockQuantity":"", "section":"", "mortgageRegistrationDate":"", "placeOfIssue":"", "landRegistryNumber":"", "maturityDate":"", "registrationDate":"", "model":"", "usageRestriction":"", "state":"IN-RJ", "plan":"", "creditorOutstandingCurrency":"", "numberOfFloors":"2", "contractStartDate":"", "securityId":"", "usefulLife":"", "chassisNumber":"", "debtorOutstanding":"", "builtUpArea":"", "size":"", "beneficiary":"", "contractExpiryDate":"", "mortgageRank":"", "constructionCompletionDate":"2024-01-05 12:00:00.000", "isincusip":"", "currentInterestRate":"", "expectedConstructionCompletionDate":"", "securityName":"", "pariPassuPercentage":"", "city":"abcd", "costPriceCurrency":"", "plotNo":"", "landRegistryDistrict":"", "underLease":"", "sellerName":"", "description":"", "industry":"", "bankName":"", "yearsOfConstruction":"", "manufacturer":"", "usageDetails":"", "expiryDate":"", "propertyStatus":"", "interestRateAsOf":"", "debtorOutstandingCurrency":"", "doorNumber":"5", "mortgagePropertyType":"01", "propertyType":"", "floorNumber":"", "insuredPremiumAmount":"", "make":"", "openingDate":"", "quantity":"", "address2":"", "stockType":"", "address1":"abcd", "issuerName":"", "engineNumber":"", "costPrice":"", "dateOfIssue":"", "accountNumber":"", "insuredPremiumAmountCurrency":"", "pariPassu":"", "mortgagePropertyStatus":"01", "creditorOutstanding":"", "propertyUsage":"01" } ,"lastChangeUserId":"", "comments":"", "collateralOverview": { "owner":"", "ltvRatio":"5.00", "adjustedCollateralValue":"100000.00", "collateralType":"01", "collateralStatus":"01", "salvageCurrency":"", "registeredPropertyOwnerName":"", "collateralSubType":"002", "additionalOwners":"", "propertyCostCurrency":"USD", "registeredPropertyOwner":"Umesh", "collateralName":"", "propertyCost":100000,"beneficiary":"", "salvageValue":"", "adjustedCollateralCurrency":"USD", "isInsuranceRequired":"", "collateralId":"C202245727030", "advancedRate":"100", "collateralSource":"02" } ,"lastChangeDateTime":"2022-11-21", "partyId":"NNVF1591132733", "collateralRelationshipResponse":[ { "lastChangeUserId":"", "facilityId":"F202245705558", "amendRequestType":"", "requestId":"R202245705514", "lastChangeDateTime":"2022-11-21 12:42:07.763", "collateralId":"C202245727030", "amendRequestTypeStatus":"", "extensionData": { } } ],"extensionData": { } } ],"opstatus":0,"httpStatusCode":200 } |
||||
Error Code(s): |
Error Code: 8009 Error Message: Backend request failed for service getCollateral with HTTP status code 400. |
||||
Enterprise Provider: | Corporate LOS MS | ||||
Service Flow: |
|

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: |
|
||||
Body Request: | { "Purpose": "Onboarding", "BranchRef": "GB0010001" } |
||||
Response: | Click here for response |
||||
Error Code(s): |
None |
||||
Service Flow: |
|

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 ![]() /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. ![]() { "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): |
|
||||
Service Flow: |
|

Description: | Retrieves all the Certificate of Deposit plans that are associated with a product. The Certificate of Deposit plans are generated based on the amount range and time period. | |||||
Method: | POST | |||||
URL: | {baseUrl}/services/data/v1/ProductsSelectionManagement/operations/ProductSelection/getAllCDPlans/ | |||||
Security Level: | Authenticated App User | |||||
Header Request: |
|
|||||
Body Request: |
Parameters IndexKey Specifies the Index key. Currency Specifies the currency code used in the application. EffectiveDate Specifies the effective date. ProductId Specifies the unique ID of the product. BranchRef Specifies the branch reference number. { "IndexKey": "05", "Currency": "USD", "EffectiveDate": "2020-08-26", "ProductId": "HOME.EQUITY.LOAN", "BranchRef": "GB0010001" } |
|||||
Response: |
Parameters /periodicInterests Specifies an array of periodic interests of the product in a JSON object. /periodicInterests/periodicIntId Specifies the unique ID for the periodic interest. /periodicInterests/period Specifies the duration of period. /periodicInterests/indexKey Specifies the Index key. /periodicInterests/currency Specifies the currency code used in the application. /periodicInterests/effectiveDate Specifies the effective date. /periodicInterests/branchRef Specifies the branch reference number. /periodicInterests/periodicRates Specifies the periodic rate. /periodicInterests/periodicRates/minAmount Specifies the minimum amount for the periodic rate. /periodicInterests/periodicRates/maxAmount Specifies the maximum amount for the periodic rate. /periodicInterests/periodicRates/bidRate Specifies the bid rate. /periodicInterests/periodicRates/offerRate Specifies the offer rate. /periodicInterests/periodicRates/apr Specifies the Annual Percentage Rate. /periodicInterests/extensionData Specifies the extension data. { "periodicInterests": [ { "periodicIntId": "PI20238SQHMC", "period": "6M", "indexKey": "05", "currency": "USD", "effectiveDate": "2019-02-09", "branchRef": "GB0010001", "periodicRates": [ { "minAmount": 10000, "maxAmount": "90000", "bidRate": 0.052, "offerRate": 0.072, "apr": 0.53 }, { "minAmount": 90001, "maxAmount": "100000", "bidRate": 0.052, "offerRate": 0.072, "apr": 0.53 }, { "minAmount": 100001, "maxAmount": "110000", "bidRate": 0.052, "offerRate": 0.072, "apr": 0.53 } ], "extensionData": {} } ] } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | Retrieves the list of products from the Marketing Catalog microservice based on the specified purpose. For example, the Deposit product group contains various products such as Long Term Deposits, 3 year Deposits, and so on. If the user sets the purpose as Onboarding then all the products that are associated with Origination are fetched. | ||||
Method: | POST | ||||
URL: | {{baseURl}}/services/data/v1/ProductsSelectionManagement/operations/ProductSelection/getProductsForPurpose | ||||
Security Level: | Authenticated App User | ||||
Header Request: | None | ||||
Body Request: |
Parameters Purpose (Mandatory) Specifies the purpose for which the list of products is fetched. BranchRef (Mandatory) Specifies the Branch Reference. { "Purpose": "Onboarding", "BranchRef": "GB0010001" } |
||||
Response: |
![]() { "productCatalogue": [{ "externalIndicator": false, "productLineRef": "LENDING", "productLineName": "Lending", "productGroups": [{ "externalIndicator": false, "imageDetails": [{ "imageUrl": "landingpg2.png", "width": 120, "imageType": "Banner", "extensionData": {}, "height": 720 }, { "imageUrl": "personal_loan.png", "width": 120, "imageType": "Icon", "extensionData": {}, "height": 720 }, { "imageUrl": "product_image.png", "width": 120, "imageType": "Content", "extensionData": {}, "height": 720 }], "productGroupId": "PG2029428DJF", "productGroupName": "Personal Loan", "description": "Start living your dreams with personal loans up to $35000.", "detailedDesc": "A personal loan is an installment loan that you can use for a variety of reasons 2.From debt consolidation to home improvements to vacations, you can plan for both the expected and unexpected surprising trips.", "branchRef": "GB0010001", "productGroupRef": "PERSONAL.LOANS", "products": [{ "externalIndicator": false, "productFeatures": [], "apr": 0.53, "productId": "PR20294YECBN", "imageDetails": [{ "imageUrl": "landingpage_3_img2.png", "width": 120, "imageType": "Content", "extensionData": {}, "height": 720 }, { "imageUrl": "banner.png", "width": 120, "imageType": "Banner", "extensionData": {}, "height": 720 }, { "imageUrl": "banner_large.png", "width": 120, "imageType": "Banner_Large", "extensionData": {}, "height": 720 }, { "imageUrl": "personal_loan@2x.png", "width": 120, "imageType": "Icon", "extensionData": {}, "height": 720 }], "productDetails": [{ "productDetailsId": "PD20294F3G7F", "currency": "CHF", "debitInterests": [], "creditInterests": [] }, { "productDetailsId": "PD20294EYY0J", "currency": "SGD", "debitInterests": [], "creditInterests": [] }, { "productDetailsId": "PD20294CKR3E", "currency": "EUR", "debitInterests": [], "creditInterests": [] }, { "productDetailsId": "PD202945EPR8", "currency": "GBP", "debitInterests": [], "creditInterests": [] }, { "productDetailsId": "PD202946KY72", "currency": "USD", "debitInterests": [], "creditInterests": [] }], "availableFrom": "2020-01-01", "productName": "Instant Personal Loan", "availableTo": "3020-01-01", "extensionData": { "key1": "val1" }, "purposes": ["Onboarding", "Simulation"], "productRef": "PERSONAL.LOAN", "branchRef": "GB0010001", "productDescription": { "disclosure": "", "notes": "Special pricing for Retail Customer|+|Processing fee as low as 0.99%|+|Repayment in Easy EMI with flexible tenure up to 60 months|+|Minimum loan amount – $5000|+|Maximum loan amount – Unsecured up to $100000", "termsConditions": "<b>1.</b> Estimate obtained based on the information provided by the user. It does not constitute an offer for the application for a Personal Loan.<br><br><b>2.</b> The application, granting and amount of the Personal Loan will be subject to subsequent approval by our risks department.<br><br><b>3.</b> Provided that you fulfill all our eligibility requirements for a Personal Loan.<br><br><b>4.</b> The amount of any of the above payments must be equal to or greater that $100 per month.<br> If you do not fulfill the above requirement, the interest rate applicable after non-fulfillment will vary and will be the result of adding an additional margin of 2.00% to the annual nominal interest rate.<br><br>", "description": "Start living your dreams with personal loans up to $35000", "detailedDesc": "With our Personal Loan, continue to stay ahead of your competitors. We curate Personal Loan with competitive interest rates, flexible tenures and minimal documentation to meet all your Personal needs", "extensionData": {} }, "status": "Active" }] }], "productLineId": "PL202930W1Y2" }] } |
||||
Error Code(s): |
|
||||
Service Flow: |
|

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: |
|
||||
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): |
|
||||
Service Flow: |
|

Description: | Updates the selected products in the Origination Data Microservice (ODMS); and the Product IDs in Temenos Digital. | ||||||
Method: | PUT | ||||||
URL: | {{baseUrl}}/services/data/v1/ProductsSelectionManagement/operations/ProductSelection/updateProductSelection | ||||||
Security Level: | Authenticated App User | ||||||
Header Request: |
|
||||||
Body Request: |
Parameters /ApplicantType Specifies the type of applicant. /NoOfProducts Specifies the number of products. /ProductIDs Specifies the unique IDs of the products that must be updated. /Products Specifies an array of products and their corresponding details in a JSON object. /Products/ProductLineId Specifies the unique product line ID. /Products/ProductLineRef Specifies the product reference line. /Products/ProductLineDisplayName Specifies the product display line name. /Products/ProductGroupId Specifies the unique ID of the product group. /Products/ProductGroupRef Specifies the reference number of the product group. /Products/ProductCurrencyId Specifies the unique ID of the product currency. /Products/ProductGroupDisplayName Specifies the display name of the product group. /Products/ProductName Specifies the name of the product. /Products/ProductId Specifies the unique ID of the product. /Products/ProductRef Specifies the reference code for the product. /Products/AccountNumber Specifies the account number of the user. /Products/BranchReference Specifies the reference code of the branch. /SectionProgress Specifies the progress made by the user to the current section (InProgress/Done). /EntityId Specifies the record ID for the entity item data. /ConsentIdentifier Specifies the consent identifier type. /AcceptanceStatus Specifies the acceptance status of record (Yes/No). { "ApplicantType": "Applicant", "NoOfProducts": 1, "ProductIDs": "MORTGAGE.OFFER", "Products": { "Product": [{ "ProductLineId": "PL21334GTHOQ", "ProductLineRef": "LENDING", "ProductLineDisplayName": "Lending", "ProductGroupId": "PG21334AMYWL", "ProductGroupRef": "MORTGAGES", "ProductCurrencyId": "USD", "ProductGroupDisplayName": "Mortgage", "ProductName": "Fixed Rate Mortgage", "ProductId": "PR21334YJQK6", "ProductRef": "MORTGAGE.OFFER", "AccountNumber": " ", "BranchReference": "GB0010001", "Loan": { "NoOfLoans": "1", "LoanPurpose": "First time buyer", "Description": "", "MaximumEligibleAmount": "280,000", "Simulations": [{ "LoanId": "1", "LoanAmount": "42000", "InstallmentAmount": "4295.91", "RepaymentFrequency": "Monthly", "RepaymentType": "Annuity", "InterestRate": "5.00", "InterestType": "Fixed", "Term": "10", "FixedInterestTerm": "30", "MortgageType": "Annuity", "MortgageProduct": "", "APR": "5.6734", "PaymentStartDate": "2022-03-22", "PaymentEndDate": "2022-12-22", "Charges": "100", "Schedule": [{ "DueDate": "15/05/21", "scheduleDetails": [{ "totalPayment": "1,488.59", "outstandingAmount": "-199,333.33", "dueAmount": "666.67", "paymentTypeName": "Linear Principal.", "property": "Account", "propertyAmount": "666.67" }] }] }] } }] }, "SectionProgress": "InProgress", "EntityId": "6214d718ba2b7d03b9fff710", "ConsentIdentifier": "Create_ProductSelection_Consent", "AcceptanceStatus": "Yes" } |
||||||
Response: | {"opstatus":0,"httpStatusCode":0} |
||||||
Error Code(s): |
|
||||||
Service Flow: |
|

Description: | Retrieves all the saved products from the Origination Data Microservice (ODMS). | |||||||
Method: | POST | |||||||
URL: | {{baseUrl}}/services/data/v1/ProductSelectionManagement/operations/ProductSelection/getProductSelection | |||||||
Security Level: | Authenticated App User | |||||||
Header Request: |
|
|||||||
Body Request: |
Parameters ApplicantType Specifies the type of applicant. { "ApplicantType": "Applicant" } |
|||||||
Response: | { "NoOfProducts": "1", "Products": [{ "ProductLineDisplayName": "Facility", "ProductGroupId": "PG213350ZGWQ", "ProductGroupDisplayName": "Mortgage", "ProductGroupRef": "MORTGAGE.FACILITIES", "ProductCurrencyId": "USD", "ProductName": "Mortgage Facility", "Loan": { "Simulations": [{ "LoanAmount": "555", "PeriodicIndex": "99", "LoanId": "1", "MortgageProductGroup": "MORTGAGES", "MortgageProductName": "Mortgage (Special Offer)", "MortgageType": "Annuity", "Term": "30", "FixedInterestTerm": "10", "InterestRate": "5", "MortgageProduct": "MORTGAGE.OFFER" }, { "LoanAmount": "555", "PeriodicIndex": "99", "LoanId": "2", "MortgageProductGroup": "MORTGAGES", "MortgageProductName": "Mortgage (Special Offer)", "MortgageType": "Annuity", "Term": "29", "FixedInterestTerm": "12", "InterestRate": "5", "MortgageProduct": "MORTGAGE.OFFER" } ], "NoOfLoans": "2", "Description": "", "MaximumAllowedTerm": "30", "MaximumEligibleAmount": "1110", "LoanPurpose": "First time buyer" }, "ProductLineRef": "FACILITY", "ProductId": "PR21335OM44E", "ProductRef": "MORTGAGE.FACILITY", "ProductLineId": "PL21335ZLWB4" } ], "opstatus": 0, "ID": "62617dcb547cbf232f8b17e4", "httpStatusCode": 0 } |
|||||||
Error Code(s): |
|
|||||||
Service Flow: |
|

Description: | This API allows to create/update Collateral details in ODMS. | ||||||
Method: | POST | ||||||
URL: | {{baseUrl}}/services/data/v1/ProductSelectionManagement/operations/Collateral/updateDetails | ||||||
Security Level: | Authenticated App User | ||||||
Header Request: |
X-Kony-Authorization |
||||||
Body Request: |
Parameters ApplicantType Specifies the type of applicant. { "CurrencyId" : "USD", "PropertyIdentified" :true, "EntityId": "61a5ad6da63a382b3a7f0a8a", "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": 2, "AddressLine1": "9225 Bee Cave Road", "AddressLine2": "300", "City": "Austin", "State": "US-TX", "Country": "US", "Zipcode": "78733" } } |
||||||
Response: |
{ "opstatus": 0, "httpStatusCode": 200, "status": "Collateral details is updated successfully in ODMS" } |
||||||
Error Code(s): |
|
||||||
Service Flow: |
|

Description: | This API allows to generate the document. | ||||||
Method: | POST | ||||||
URL: | {{baseURL}}/services/data/v1/ProductsSelectionManagement/operations/MortgageComposition/generateDocument | ||||||
Security Level: | Authenticated App User | ||||||
Header Request: |
X-Kony-Authorization |
||||||
Body Request: |
Parameters ApplicantType Specifies the type of applicant. { "applicationId":"22ML4CL9H", "LoanId": "1", } |
||||||
Response: |
{ "opstatus": 0, "documentName": "receipt-1905346032.pdf", "message": "Document downloaded successfully", "content": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9DcmVhdG9yIChDaHJvbWl1bSkKL1Byb2R1Y2VyIChTa2lhL1BERiBtODMpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyMjAyMjIxMjQ3MTkrMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDIyMD", "httpStatusCode": 200 } |
||||||
Error Code(s): |
|
||||||
Service Flow: |
|
updatePaymentSchedule
Description: | This API allows to schedule the data in ODMS. | ||||||
Method: | POST | ||||||
URL: | {{baseURL}}/services/data/v1/ProductsSelectionManagement/operations/MortgageComposition/updatePaymentSchedule | ||||||
Security Level: | Authenticated App User | ||||||
Header Request: |
X-Kony-Authorization |
||||||
Body Request: |
Parameters ApplicantType Specifies the type of applicant. { "applicationId":"22ML4CL9H", } |
||||||
Response: |
{ "opstatus":0, "httpStatusCode":200, "status":"Schedule Updated Successfully" } |
||||||
Error Code(s): |
|
||||||
Service Flow: |
|
In this topic