FTOS_BP_GetBankingProductDetails

Returns the banking product details based on its product code or product id.

Syntax

The FTOS_BP_GetBankingProductDetails custom endpoint is called from within the Endpoint API endpoint. Visit the Endpoint API page for more details.

Copy

POST <host_address>/ftosapi/automation-processors/actions/ftos_bp_getbankingproductdetails
Content-Type: application/json
            
{
  "productCode": "<banking_product_code>"
}

Here's a list of the available parameters:

Parameter	Description
host_address	URL of the FintechOS Platform server.
productCode	Mandatory when `productId` is not sent, string. The code of the banking product.
productId	Mandatory when `productCode` is not sent, string. The id of the banking product.

Response

The response is an object with details about a specific banking product, as follows:

Name - from FTOS_BP_BankingProduct (attribute: Name)
ProductImage - from FTOS_BP_BankingProduct (attribute: productImage )
Benefits - from FTOS_BP_BankingProduct (attribute: Benefits)
DisplayConditions - from FTOS_BP_BankingProduct (attribute: displayConditions)
NoOfDebtor - from FTOS_BP_BankingProduct (attribute: NoOfDebtor).

Example

Getting a Banking Product's Details Based on its Code

To view the details of a specific banking product, send the following request, changing the code of the product with the one you need.

Request

Copy

POST https://your_FintechOS_server/ftosapi/automation-processors/actions/ftos_bp_getbankingproductdetails
Content-Type: application/json
            
{
  "productCode": "TL_ADV"
}

Response

Copy

{
    "ProductImage": "[{"Name":"Untitled.jpg","RealName":"Untitled_9928eda6-f1a7-4f2a-a7be-0f00a32cc04d.jpg"}]",
    "Name": "Term Loan Advanced",
    "Benefits": null,
    "DisplayConditions": null,
    "NoOfDebtor": 2
}

Getting a Banking Product's Details Based on its ID

To view the details of a specific banking product, send the following request, changing the id of the product with the one you need.

Request

Copy

POST https://your_FintechOS_server/ftosapi/automation-processors/actions/ftos_bp_getbankingproductdetails
Content-Type: application/json
            
{
  "productId": "EEC720BA-6C32-47AC-9050-3D9D759F043E"
}

Response

Copy

{
    "ProductImage": "[{"Name":"Untitled.jpg","RealName":"Untitled_9928eda6-f1a7-4f2a-a7be-0f00a32cc04d.jpg"}]",
    "Name": "Term Loan Advanced",
    "Benefits": null,
    "DisplayConditions": null,
    "NoOfDebtor": 2
}