FTOS_BP_GetInterestListDetail

Returns the details of a specific interest list based on its name or id.

Syntax

The FTOS_BP_GetInterestListDetail 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_getinterestlistdetail
Content-Type: application/json
            
{
  "interestListName": "<name_of_the_interest_list>"
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the FintechOS Platform server.
interestListName Mandatory when interestListId is not sent, string. The name of the interest list.
interestListId Mandatory when interestListName is not sent, string. The id of the interest list.

Response

The response is an object with details about all the interests in the interest list from FTOS_BP_Interest and FTOS_BP_InterestValue. If interest type is BankingFormula, then interestRate is equal to the formula result.

Example

To view the details of a specific interest list, send the following request, changing the name of the interest list with the one you need.

Request

Copy 
POST https://your_FintechOS_server/ftosapi/automation-processors/actions/ftos_bp_getinterestlistdetail
Content-Type: application/json
            
{
  "interestListName": "TermLoan Eur"
}

Response

Copy 
{
    "InterestListName": "BandedEUR",
    "Interests": [
        {
            "InterestName": "BandedEUR",
            "InterestCode": "BandedEUR",
            "InterestType": "Collection",
            "IsForOverdraft": true,
            "BandedInterests": [
                {
                    "InterestName": "BandedEUR_C1",
                    "MinUtilizedAmount": 0.0,
                    "MaxUtilizedAmount": 999.99,
                    "IsForOverdraft": true,
                    "CollectionValidFrom": "2024-01-30",
                    "CollectionValidTo": "2021-12-31",
                    "ValueMessage": "Valid",
                    "InterestValue": "No Active Value",
                    "FixedValue": "No Active Value"
                },
                {
                    "InterestName": "BandedEUR_C2",
                    "MinUtilizedAmount": 1000.0,
                    "MaxUtilizedAmount": 3999.99,
                    "IsForOverdraft": true,
                    "CollectionValidFrom": "2021-01-01",
                    "CollectionValidTo": "2021-12-31",
                    "ValueMessage": "Valid",
                    "InterestValue": 2.0,
                    "MarginValue": "No Active Value",
                    "BaseInterestName": "IRCC 3M",
                    "BaseInterestCode": "IRCC 3M",
                    "BaseInterestValidFrom": {
                        "invariantDate": "2021-03-01"
                    },
                    "BaseInterestValidTo": {
                        "invariantDate": "2031-03-31"
                    },
                    "BaseInterestValue": 2.0
                },
                {
                    "InterestName": "BandedEUR_C3",
                    "MinUtilizedAmount": 4000.0,
                    "MaxUtilizedAmount": 10000000.0,
                    "IsForOverdraft": true,
                    "CollectionValidFrom": "2021-01-01",
                    "CollectionValidTo": "2021-12-31",
                    "ValueMessage": "Valid",
                    "InterestValue": "No Active Value",
                    "FixedValue": "No Active Value"
                }
            ]
        }
    ]
}

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

Request

Copy 
POST https://your_FintechOS_server/ftosapi/automation-processors/actions/ftos_bp_getinterestlistdetail
Content-Type: application/json
            
{
  "interestListId": "CEA804D9-2EBB-4212-8174-C808B3D803FE"
}

Response

Copy 
{
    "InterestListName": "BandedEUR",
    "Interests": [
        {
            "InterestName": "BandedEUR",
            "InterestCode": "BandedEUR",
            "InterestType": "Collection",
            "IsForOverdraft": true,
            "BandedInterests": [
                {
                    "InterestName": "BandedEUR_C1",
                    "MinUtilizedAmount": 0.0,
                    "MaxUtilizedAmount": 999.99,
                    "IsForOverdraft": true,
                    "CollectionValidFrom": "2024-01-30",
                    "CollectionValidTo": "2021-12-31",
                    "ValueMessage": "Valid",
                    "InterestValue": "No Active Value",
                    "FixedValue": "No Active Value"
                },
                {
                    "InterestName": "BandedEUR_C2",
                    "MinUtilizedAmount": 1000.0,
                    "MaxUtilizedAmount": 3999.99,
                    "IsForOverdraft": true,
                    "CollectionValidFrom": "2021-01-01",
                    "CollectionValidTo": "2021-12-31",
                    "ValueMessage": "Valid",
                    "InterestValue": 2.0,
                    "MarginValue": "No Active Value",
                    "BaseInterestName": "IRCC 3M",
                    "BaseInterestCode": "IRCC 3M",
                    "BaseInterestValidFrom": {
                        "invariantDate": "2021-03-01"
                    },
                    "BaseInterestValidTo": {
                        "invariantDate": "2031-03-31"
                    },
                    "BaseInterestValue": 2.0
                },
                {
                    "InterestName": "BandedEUR_C3",
                    "MinUtilizedAmount": 4000.0,
                    "MaxUtilizedAmount": 10000000.0,
                    "IsForOverdraft": true,
                    "CollectionValidFrom": "2021-01-01",
                    "CollectionValidTo": "2021-12-31",
                    "ValueMessage": "Valid",
                    "InterestValue": "No Active Value",
                    "FixedValue": "No Active Value"
                }
            ]
        }
    ]
}