Funding
| Name | Description | Introduced In |
|---|---|---|
| getProducts | This API retrieves the products that are selected by the user for funding. This API is used to re-populate the data while the user navigates back to the client app. | 2021.01 |
| getType | This API retrieves the funding type that is set by the user. Inter-Bank Funding and Intra-Bank Funding are the two types of funding that are used in the Funding module (Intra/Inter). | 2021.01 |
| getSelectedProducts | This API retrieves the product that is selected by the user based on the application ID. The product is retrieved from the customer application and the Party back-end system. | 2021.01 |
| updateData | This API updates the funding data to the Origination Data Microservice (ODMS). | 2021.01 |
getType
| Description: | Retrieves the funding type that is set by the user. Inter-Bank Funding and Intra-Bank Funding are the two types of funding that are used in the Funding module (Intra/Inter). | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/Funding/operations/Funding/getType | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
X-Kony-Authorization |
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the entity definition key. {
"Application_id": "W2HHB2T"
}
|
||||||
| Response: |
Parameters /FundingType Specifies the type of funding. //Success Response
{
"FundingType": "Inter",
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Get funding type failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getProducts
| Description: | Retrieves the products that are selected by the user for funding. This API is used to re-populate the data while the user navigates back to the client app. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/Funding/operations/Funding/getProducts | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
X-Kony-Authorization |
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the entity definition key. {
"Application_id": "W2HHB2T"
}
|
||||||
| Response: |
Parameters /FundingProducts Specifies an array of details of the funding product in a JSON object. /FundingProduct/FundingProductId Specifies the ID of the funding product. /FundingProduct/FundingCurrency Specifies the currency used in funding. /FundingProduct/FundingAmount Specifies the amount of the funding. /FundingProduct/DebitIBAN Specifies the International Bank Account Number of the debtor. /FundingProduct/DebitAccount Specifies the debit account number. /FundingProduct/DebitRoutingNumber Specifies the routing number for the debit account. /FundingProduct/DebitCurrency Specifies the currency of the debit account. /FundingProduct/DebitAccountType Specifies the type of the debit account. /FundingProduct/BankName Specifies the name of the bank. /FundingProduct/PaymentReference Specifies the reference code generated for the payment. //Success Response
{
"FundingProducts": [
{
"FundingProductId": "",
"FundingCDPlanId": "",
"FundingCurrency": "",
"FundingAmount": "",
"DebitAccount": "",
"DebitCurrency": "",
"DebitIBAN": "",
"DebitRoutingNumber": "",
"DebitAccountType": "",
"BankName": "",
"PaymentReference": ""
}
],
"opstatus": 0,
"httpStatusCode": 0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Funding update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
getSelectedProducts
| Description: | Retrieves the product that is selected by the user based on the application ID. The product is retrieved from the customer application and the Party back-end system. | ||||||
| Method: | POST | ||||||
| URL: | {{baseUrl}}/services/data/v1/Funding/operations/Funding/getSelectedProducts | ||||||
| Security Level: | Authenticated App Users | ||||||
| Header Request: |
X-Kony-Authorization |
||||||
| Body Request: |
Parameters Application_id (Mandatory) Specifies the entity definition key. {
"Application_id": "ZBL55R5"
}
|
||||||
| Response: |
Parameters View the Response Parameters
/productCatalogue Specifies the product catalog details. /productCatalogue/productFeatures Specifies the various features that are associated with a product present in the catalog. /productCatalogue/fees Specifies the fee details that are associated with the product catalog. /productCatalogue/fees/feeAmount Specifies the fee amount. /productCatalogue/productId Specifies the ID of the product. /productCatalogue/creditInterest Specifies the credit interest details such as interest rate and interest type. /productCatalogue/creditInterest/interestRate Specifies the interest rate. /productCatalogue/creditInterest/interestType Specifies the type of interest. /productCatalogue/imageDetails Specifie the image details that are associated with the product catalog. /productCatalogue/maximumAmount Specifies the maximum amount of the product. /productCatalogue/overdraftAmount Specifies the overdraft amount associated with the product. /productCatalogue/productName Specifies the name of the product. /productCatalogue/extensionData Specifies the extension data that is associated with the product. /productCatalogue/noticePeriod Specifies the notice period details for the product catalog. /productCatalogue/noticePeriod/weeks Specifies the number of weeks in the notice period. /productCatalogue/noticePeriod/months Specifies the number of months in the notice period. /productCatalogue/noticePeriod/days Specifies the number of days in the notice period. /productCatalogue/noticePeriod/years Specifies the number of years in the notice period. /productCatalogue/purposes Specifiees the purpose of the product that is present in the product catalog. /productCatalogue/minimumAmount Specifies the minimum amount. /productCatalogue/debitInterest Specifies the debit interest details such as interest rate and interest type. /productCatalogue/debitInterest/interestRate Specifies the interest rate. /productCatalogue/debitInterest/interestType Specifies the interest type. /productCatalogue/currencyId Specifies the ID of currency. /productCatalogue/productDescription Specifies a description about the product. /productCatalogue/status Specifies the status of the product catalog. View the Response Sample Code
{
"productCatalogue": [
{
"productFeatures": [],
"fees": {
"feeAmount": 5
},
"productId": "SAVINGS.DEFAULT",
"creditInterest": {
"interestRate": 0
},
"imageDetails": [],
"maximumAmount": 500,
"overdraftAmount": 50,
"productName": "Default (for failed eligibility)",
"extensionData": {},
"noticePeriod": {
"weeks": 2,
"months": 5,
"days": 10,
"years": 10
},
"purposes": [
"Onboarding"
],
"minimumAmount": 5,
"currencyId": "CAD",
"productDescription": "A variable interest rate account that earns competitive interest and has no minimum balance or monthly service charge after you open it.",
"status": "Active"
},
{
"productFeatures": [],
"fees": {
"feeAmount": 35
},
"productId": "PREMIUM.ACCOUNT",
"creditInterest": {
"interestRate": 0,
"interestType": "SINGLE"
},
"imageDetails": [],
"maximumAmount": 500,
"overdraftAmount": 50,
"productName": "Current Account (Premium)",
"extensionData": {},
"noticePeriod": {
"weeks": 2,
"months": 5,
"days": 10,
"years": 10
},
"purposes": [
"Onboarding"
],
"minimumAmount": 5,
"debitInterest": {
"interestRate": 0,
"interestType": "SINGLE"
},
"currencyId": "USD",
"productDescription": "Looking to earn more? Simply maintain a balance of $999 or more to earn a higher variable interest rate. You will still earn a competitive rate even if your balance falls below $999.",
"status": "Active"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
updateData
| Description: | Updates the funding data to the Origination Data Microservice (ODMS). | ||||||
| Method: | PUT | ||||||
| URL: | <BASE URI>/services/data/v1/Funding/operations/Funding/updateData | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: |
|
||||||
| Body Request: |
Parameters /Application_id Specifies the entity definition key. /Payload Specifies the payload JSON object. /Payload/FundingType Specifies the type of funding (Inter/Intra) /Payload/FundingStatus Specifies the status of funding. /Payload/FundingProduct Specifies an array of funding products and their corresponding details. /Payload/FundingProduct/FundingProductId Specifies the unique ID of the funding product. /Payload/FundingProduct/FundingCurrency Specifies the currency of the funding. /Payload/FundingProduct/FundingAmount Specifies the amount involved in the funding {
"Application_id": "W2HHB2T",
"Payload": {
"FundingType": "Inter",
"FundingStatus": "OptedOut",
"FundingProduct": [
{
"FundingProductId": "12547",
"FundingCurrency": "USD",
"FundingAmount": "10000"
}
]
},
"MetaData": {
"SectionProgress": "InProgress"
}
}
|
||||||
| Response: | //Success Response
{
"opstatus":0,
"httpStatusCode":0
}
//Error Response
{
"httpStatusCode": 200,
"opstatus": 0,
"dbpErrCode": 73200,
"dbpErrMsg": "Funding update failed"
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
In this topic