FTOS_BP_GetBankingProductByCode
Returns the banking product information based on its product code. If more versions are available, only the approved one is taken into consideration.
Syntax
The FTOS_BP_GetBankingProductByCode 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_getbankingproductbycode
Content-Type: application/json
{
"BankingProductCode": "<banking_product_code>",
"displayBPAvailability": <true_or_false>,
"displayBPDimensions": <true_or_false>,
"displayInterestsAndCommissions": <true_or_false>,
"displayInsurance": <true_or_false>,
"displayDiscounts": <true_or_false>,
"displayQuestions": <true_or_false>,
"displayCountryCalendars": <true_or_false>,
"displayPaymentScheduleTypes": <true_or_false>,
"displayProductGuarantees": <true_or_false>,
"displayProductDestinationTypes": <true_or_false>,
"displayDisbursementMatrix": <true_or_false>,
"displayAssociatedProducts": <true_or_false>,
"displayMandatoryRoles": <true_or_false>
}Here's a list of the available parameters:
| Parameter | Description |
|---|---|
| host_address | URL of the FintechOS Platform server. |
| BankingProductCode | Mandatory, string. The code of the banking product. |
| displayBPAvailability | Optional, boolean. Specifies whether to show the availability information of the banking product, such as currency, period, minimum and maximum amounts and advances, item filters, or covenants. Possible values: true, false. The Availability section of the output is only displayed for true value. |
| displayBPDetails | Optional, boolean. Specifies whether to show the general data in the details section of the banking product. Possible values: true, false. The GeneralData section of the output is only displayed for true value. |
| displayBPDimensions | Optional, boolean. Specifies whether to show the dimensions information of the banking product, such as interests and commissions, insurances, discounts or questions. Only the active values for interests and for commissions are returned within the response. Possible values: true, false. The Dimensions section of the output is only displayed for true value. |
| displayInterestsAndCommissions | Optional, boolean. Specifies whether to show the interests and commissions of the banking product. Only the active values for interests and for commissions are returned within the response. Possible values: true, false. The InterestsAndCommissions section of the output is only displayed for true value. |
| displayInsurance | Optional, boolean. Specifies whether to show the insurances of the banking product. Possible values: true, false. The Insurance section of the output is only displayed for true value. |
| displayDiscounts | Optional, boolean. Specifies whether to show the discounts of the banking product. Possible values: true, false. The Discounts section of the output is only displayed for true value. |
| displayQuestions | Optional, boolean. Specifies whether to show the questions of the banking product. Possible values: true, false. The Questions section of the output is only displayed for true value. |
| displayCountryCalendars | Optional, boolean. Specifies whether to show the country calendars of the banking product. Possible values: true, false. The CountryCalendars section of the output is only displayed for true value. |
| displayPaymentScheduleTypes | Optional, boolean. Specifies whether to show the associated payment schedule types of the banking product. Possible values: true, false. The AssociatedPaymentScheduleTypes section of the output is only displayed for true value. |
| displayProductGuarantees | Optional, boolean. Specifies whether to show the product guarantees of the banking product. Possible values: true, false. The ProductGuarantees section of the output is only displayed for true value. |
| displayProductDestinationTypes | Optional, boolean. Specifies whether to show the product destination types of the banking product. Possible values: true, false. The ProductDestinationTypes section of the output is only displayed for true value. |
| displayDisbursementMatrix | Optional, boolean. Specifies whether to show the disbursement matrix of the banking product. Possible values: true, false. The DisbursementMatrix section of the output is only displayed for true value. |
| displayAssociatedProducts | Optional, boolean. Specifies whether to show the associated products of the banking product. Possible values: true, false. The AssociatedProducts section of the output is only displayed for true value. |
| displayMandatoryRoles | Optional, boolean. Specifies whether to show the mandatory roles information of the banking product. Possible values: true, false. The MandatoryRoles section of the output is only displayed for true value. |
Response
The response is an object with details about a specific banking product from the FTOS_BP_BankingProduct entity. The data enclosed in a specific section is returned only if their corresponding flags are set to true.
Copy
{
"BankingProduct": {
"BankingProductCode": "BankingProductCode",
"Name": "Name",
"StartDate": "StartDate",
"EndDate": "EndDate",
"BankingProductType": "BankingProductType"
},
"Details": {
"GeneralData": {
"BankAccountType": "BankAccountType",
"IsRevolving": false,
"AutoDisbursement": false,
"MaxNoDisbursements": 0.0,
"ActivationTranchesOnDocumentSubmission": false,
"IsGuaranteed": false,
"AllowCollateralPartialRelease": null,
"AllowCoDebtor": false,
"AllowRefinancing": false,
"MaxNoOfCodebtors": 0.0,
"PeriodicityType": "PeriodicityType",
"RepaymentAllocationMethod": "RepaymentAllocationMethod",
"HolidayShiftForRepaymentInstallments": false,
"HolidayShiftMethod": "HolidayShiftMethod",
"DeferDueDate": false,
"GraceType": "GraceType",
"ProductGrace": "ProductGrace",
"GraceDaysForRepayment": 0.0,
"PenaltyForGracePeriod": false
},
"CountryCalendars": [
{
"CountryName": "CountryName"
}
],
"AssociatedPaymentScheduleTypes": [
{
"PaymentScheduleTypeId": "PaymentScheduleTypeId",
"PaymentScheduleTypeName": "PaymentScheduleTypeName",
"PaymentScheduleCode": "PaymentScheduleCode",
"ProductType": "ProductType",
"ScheduleInterestCalculationType": "ScheduleInterestCalculationType",
"IsWithEqualInstallments": false,
"InstallmentValueCustom": false,
"UseMaturityDate": false,
"MeasurementUnit": "MeasurementUnit",
"PaymentScheduleTypeDetails": [
{
"PaymentScheduleTypeDetailId": "PaymentScheduleTypeDetailId",
"ColumnRepaymentSchedule": "ColumnRepaymentSchedule",
"CalculationMethod": "CalculationMethod",
"Fee": "Fee",
"InsuranceClass": "InsuranceClass",
"Source": "Source",
"Display": false
}
]
}
],
"ProductGuarantees": [
{
"ProductGuaranteeName": "ProductGuaranteeName",
"GuaranteeType": "GuaranteeType",
"MaxAcceptedCoveringPercent": 0.0
}
],
"ProductDestinationTypes": [
{
"ProductDestinationTypeName": "ProductDestinationTypeName",
"IsDefault": false
}
],
"DisbursementMatrix": [
{
"Name": "Name",
"TranchePercent": 0.0,
"InterestPercent": 0.0,
"StartMonthFromActivation": 0.0,
"UnusageCommissionPercent": 0.0
}
],
"AssociatedProducts": [
{
"AssociatedProductName": "AssociatedProductName",
"AssociatedProductCode": "AssociatedProductCode"
}
]
},
"Availability": {
"Currency": "Currency",
"PeriodType": "PeriodType",
"MaxPeriodForDisbursement": 0.0,
"MinimumPeriod": 0.0,
"MaximumPeriod": 0.0,
"MinimumEarlyRepaymentValue": 0.0,
"MinimumAmount": 0.0,
"MaximumAmount": 0.0,
"UnusageStartPeriod": 0.0,
"MinimumAdvance": 0.0,
"MaximumAdvance": 0.0,
"AvailabilityItemFilters": [
{
"Filter": "Filter",
"FilterScope": "FilterScope",
"FilterType": "FilterType",
"Description": "Description"
}
],
"ProductCovenants": [
{
"Name": "Name",
"Type": "Type",
"Value": 0.0,
"ValidFrom": {
"invariantDate": "invariantDate"
},
"ValidTo": {
"invariantDate": "invariantDate"
},
"ReviewFrequencyMonths": 0.0
}
],
"MandatoryRoles": [
{
"Name": "Name",
"SearchLimit": false
}
]
},
"Dimensions": {
"InterestsAndCommissions": [
{
"InterestCommissionItemName": "InterestCommissionItemName",
"CommissionListName": "CommissionListName",
"InterestListName": "InterestListName",
"Commissions": [
{
"Name": "Name",
"Type": "Type",
"PeriodicityType": "PeriodicityType",
"Currency": "Currency",
"Status": "Status",
"IsForUnusage": false,
"ValueIsPercent": false,
"PercentAppliedTo": "PercentAppliedTo",
"IncludedInRepaymentSchedule": false,
"AutomaticLoadOnContract": false,
"MandatoryForApplicant": false,
"UseBankingFormula": false,
"IsForContractVersion": false,
"Percent": 0.0,
"Values": [
{
"CommissionValue": 0.0,
"CommissionPercent": 0.0,
"Status": "Status",
"ValueValidFrom": {
"invariantDate": "invariantDate"
},
"ValueValidTo": {
"invariantDate": "invariantDate"
}
}
]
}
],
"Interests": [
{
"Name": "Name",
"Code": "Code",
"AppliedToLoanItemIfOverdue": "AppliedToLoanItemIfOverdue",
"Description": "Description",
"IsDefault": false,
"UseBankingFormula": false,
"Type": "Type",
"IsPenalty": false,
"IsGeneral": false,
"IsForSightDeposit": false,
"IsForOverdraft": false,
"IsCreditLine": false,
"IsDebitOrder": false,
"Values": [
{
"Value": 0.0,
"ValueStatus": "ValueStatus",
"ValueValidFrom": {
"invariantDate": "invariantDate"
},
"ValueValidTo": {
"invariantDate": "invariantDate"
}
}
],
"CollectionInterests": [
{
"InterestName": "InterestName",
"InterestStartPeriod": 0.0,
"InterestEndPeriod": 0.0,
"InterestStartDate": {
"invariantDate": "invariantDate"
},
"InterestEndDate": {
"invariantDate": "invariantDate"
}
}
]
}
]
}
],
"Insurance": [
{
"Name": "Name",
"Code": "Code",
"StartDate": {
"invariantDate": "invariantDate"
},
"EndDate": {
"invariantDate": "invariantDate"
},
"InsuranceListName": "InsuranceListName",
"Insurances": [
{
"InsuranceCode": "InsuranceCode",
"InsuranceName": "InsuranceName",
"PeriodicityType": "PeriodicityType",
"Currency": "Currency",
"Insurer": "Insurer",
"OperationItem": "OperationItem",
"IsMandatoryForApplicant": false,
"IsMandatoryForDebtor": false,
"IncludedIntoRepaymentScheduleInstallment": false,
"Class": "Class",
"UseBankingFormula": false,
"ValueIsPercentage": false,
"Description": "Description",
"BankingFormulaType": "BankingFormulaType"
}
]
}
],
"Discounts": [
{
"Name": "Name",
"Discount": "Discount",
"DiscountValue": 0.0,
"StartDate": {
"invariantDate": "invariantDate"
},
"EndDate": {
"invariantDate": "invariantDate"
},
"AppliedToDimension": "AppliedToDimension",
"CommissionType": "CommissionType",
"Commission": "Commission",
"InterestType": "InterestType",
"InsuranceClass": "InsuranceClass",
"Insurance": "Insurance",
"UseBankingFormula": false,
"BankingFormulaType": "BankingFormulaType",
"IsOptionalDiscount": false,
"DestinationEntity": "DestinationEntity",
"DestinationEntityAttribute": "DestinationEntityAttribute",
"IsPercentage": false
}
],
"Questions": [
{
"Name": "Name",
"QuestionType": "QuestionType",
"IsForSolicitant": false,
"IsForCoborrower": false,
"AnswerEntity": "AnswerEntity",
"AnswerField": "AnswerField"
}
]
}
}
Example
Getting All the Information of a Banking Product by its Code
To view the information of a specific banking product, send the following request, changing the banking product code with the one you need.
Request
Copy
POST https://your_FintechOS_server/ftosapi/automation-processors/actions/ftos_bp_getbankingproductbycode
Content-Type: application/json
{
"BankingProductCode": "TL_EUR",
"displayBPAvailability": true,
"displayBPDimensions": true,
"displayInterestsAndCommissions": true,
"displayInsurance": true,
"displayDiscounts": true,
"displayQuestions": true,
"displayCountryCalendars": true,
"displayPaymentScheduleTypes": true,
"displayProductGuarantees": true,
"displayProductDestinationTypes": true,
"displayDisbursementMatrix": true,
"displayAssociatedProducts": true,
"displayMandatoryRoles": true
}Response
Copy
{
"BankingProduct": {
"BankingProductCode": "TL_EUR",
"Name": "Term Loan Euro",
"StartDate": "Tue Mar 31 2020 21:00:00 GMT+00:00",
"EndDate": "Wed Apr 16 2025 21:00:00 GMT+00:00",
"BankingProductType": "Term Loan"
},
"Details": {
"CountryCalendars": [
{
"CountryName": "Thailand"
}
],
"AssociatedPaymentScheduleTypes": [
{
"PaymentScheduleTypeId": "b4a8ae3d-cf45-4db5-9b53-0accb466cd48",
"PaymentScheduleTypeName": "Equal principal Monthly 30/365",
"PaymentScheduleCode": "EPM365",
"ProductType": "TL",
"ScheduleInterestCalculationType": "30/365",
"IsWithEqualInstallments": false,
"InstallmentValueCustom": false,
"UseMaturityDate": true,
"MeasurementUnit": "Months",
"PaymentScheduleTypeDetails": [
{
"PaymentScheduleTypeDetailId": "97858541-a974-44f1-bb01-c55665d26f56",
"ColumnRepaymentSchedule": "Principal",
"CalculationMethod": "Liniar",
"Fee": null,
"InsuranceClass": null,
"Source": null,
"Display": true
},
{
"PaymentScheduleTypeDetailId": "ff42e853-d2cc-40fd-b53c-0dcbfa3ce7c0",
"ColumnRepaymentSchedule": "TotalInstallment",
"CalculationMethod": "ColumnFormula",
"Fee": null,
"InsuranceClass": null,
"Source": null,
"Display": true
}
]
},
],
"ProductGuarantees": [],
"ProductDestinationTypes": [],
"DisbursementMatrix": [
{
"Name": "Transa 2",
"TranchePercent": 35.0000,
"InterestPercent": 2.0000,
"StartMonthFromActivation": null,
"UnusageCommissionPercent": 2.0000
},
{
"Name": "Transa 1",
"TranchePercent": 65.0000,
"InterestPercent": 2.0000,
"StartMonthFromActivation": null,
"UnusageCommissionPercent": 2.0000
}
],
"AssociatedProducts": [
{
"AssociatedProductName": "Current Account EURO",
"AssociatedProductCode": "C_EUR"
}
]
},
"Availability": {
"Currency": "EUR",
"PeriodType": "Months",
"MaxPeriodForDisbursement": 24.0,
"MinimumPeriod": 1.0,
"MaximumPeriod": 240.0,
"MinimumEarlyRepaymentValue": 1000.0,
"MinimumAmount": 1500.0,
"MaximumAmount": 400000.0,
"UnusageStartPeriod": 1.0,
"MinimumAdvance": 0.0,
"MaximumAdvance": 60.0,
"AvailabilityItemFilters": [],
"ProductCovenants": [
{
"Name": "Borrowers should perform tax obligations",
"Type": "Affirmative",
"Value": null,
"ValidFrom": {
"invariantDate": "2021-01-01"
},
"ValidTo": {
"invariantDate": "2030-01-31"
},
"ReviewFrequencyMonths": 12
},
{
"Name": "Lender posses the righ to prevent merges or acquisitions ",
"Type": "Negative",
"Value": null,
"ValidFrom": {
"invariantDate": "2021-01-01"
},
"ValidTo": {
"invariantDate": "2040-01-31"
},
"ReviewFrequencyMonths": 6
},
{
"Name": "Lender can monitor borrower's current ratio",
"Type": "Financial",
"Value": null,
"ValidFrom": {
"invariantDate": "2020-12-30"
},
"ValidTo": {
"invariantDate": "2040-01-31"
},
"ReviewFrequencyMonths": 24
}
],
"MandatoryRoles": []
},
"Dimensions": {
"InterestsAndCommissions": [
{
"InterestCommissionItemName": "Onboarding Loan I&C",
"CommissionListName": "Term Loan Eur",
"InterestListName": "TermLoan Eur",
"Commissions": [
{
"Name": "CA Administration Fee",
"Type": "Administration Fee",
"PeriodicityType": "Monthly",
"Currency": "Euro",
"Status": "Active",
"IsForUnusage": null,
"ValueIsPercent": false,
"PercentAppliedTo": null,
"IncludedInRepaymentSchedule": true,
"AutomaticLoadOnContract": true,
"MandatoryForApplicant": true,
"UseBankingFormula": null,
"IsForContractVersion": null,
"Percent": null,
"Values": [
{
"CommissionValue": 4.0,
"CommissionPercent": null,
"Status": "Active",
"ValueValidFrom": {
"invariantDate": "2021-12-09"
},
"ValueValidTo": {
"invariantDate": "2022-12-08"
}
}
]
},
],
"Interests": [
{
"Name": "Corporate Overdue Principal",
"Code": "CoOvP",
"AppliedToLoanItemIfOverdue": "Loan Principal",
"Description": null,
"IsDefault": false,
"UseBankingFormula": false,
"Type": "Fixed",
"IsPenalty": true,
"IsGeneral": null,
"IsForSightDeposit": false,
"IsForOverdraft": null,
"IsCreditLine": false,
"IsDebitOrder": false,
"Values": [
{
"Value": 12.0,
"ValueStatus": "Active",
"ValueValidFrom": {
"invariantDate": "2021-01-01"
},
"ValueValidTo": {
"invariantDate": "2031-12-31"
}
}
],
"CollectionInterests": []
},
{
"Name": "EUR FIX 1.95",
"Code": "EUR1.95",
"AppliedToLoanItemIfOverdue": null,
"Description": null,
"IsDefault": false,
"UseBankingFormula": false,
"Type": "Fixed",
"IsPenalty": false,
"IsGeneral": false,
"IsForSightDeposit": false,
"IsForOverdraft": false,
"IsCreditLine": false,
"IsDebitOrder": false,
"Values": [
{
"Value": 1.95,
"ValueStatus": "Active",
"ValueValidFrom": {
"invariantDate": "2022-02-27"
},
"ValueValidTo": {
"invariantDate": "2029-03-12"
}
}
],
"CollectionInterests": []
},
{
"Name": "Euribor 6M",
"Code": "EU 6M",
"AppliedToLoanItemIfOverdue": null,
"Description": null,
"IsDefault": false,
"UseBankingFormula": false,
"Type": "Variable",
"IsPenalty": false,
"IsGeneral": null,
"IsForSightDeposit": false,
"IsForOverdraft": false,
"IsCreditLine": false,
"IsDebitOrder": false,
"Values": [
{
"Value": 0.5,
"ValueStatus": "Active",
"ValueValidFrom": {
"invariantDate": "2021-03-01"
},
"ValueValidTo": {
"invariantDate": "2029-01-13"
}
}
],
"CollectionInterests": []
},
{
"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",
"Value": 5.0,
"ValueMessage": "Not Valid"
},
{
"InterestName": "BandedEUR_C2",
"MinUtilizedAmount": 1000.0,
"MaxUtilizedAmount": 3999.99,
"IsForOverdraft": true,
"CollectionValidFrom": "2021-01-01",
"CollectionValidTo": "2021-12-31",
"Value": 1.0,
"ValueMessage": "Not Valid"
},
{
"InterestName": "BandedEUR_C3",
"MinUtilizedAmount": 4000.0,
"MaxUtilizedAmount": 10000000.0,
"IsForOverdraft": true,
"CollectionValidFrom": "2021-01-01",
"CollectionValidTo": "2021-12-31",
"Value": 4.9,
"ValueMessage": "Not Valid"
}
]
}
]
}
],
"Insurance": [],
"Discounts": [],
"Questions": []
}
}