FTOS_CB_AddUpdateEarlyRepayment
Adds or updates a record in the FTOS_CB_ContractEvent entity representing an event for an early repayment of a contract. The entire repayment schedule is recalculated considering this event. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_CB_AddUpdateEarlyRepayment custom endpoint is called from within the Endpoint API endpoint. Visit the Endpoint API page for more details.
POST <host_address>/ftosapi/automation-processors/actions/FTOS_CB_AddUpdateEarlyRepayment
Content-Type: application/json
{
"contractName":"<contract_number>",
"eventName":"<event_number>",
"baseAmount":<base_amount>,
"decreaseInstallment":<true_or_false>,
"repaymentFeeValue":<repayment_value>,
"repaymentFeePercent":<repayment_fee_percent>,
"externalIdentifier":"<external_identifier_of_the_transaction>",
"collectAccruedInterest": <true_or_false>
}Here's a list of the available parameters:
| Parameter | Description |
|---|---|
| host_address | URL of the FintechOS Platform server. |
| contractName | Mandatory. The number of the contract, from the FTOS_CB_Contract entity (attribute: FTOS_CB_ContractId). |
| eventName | Mandatory only for update operations. Do not send it for add operations. The number of the early payment event. |
| baseAmount | Mandatory. The plain early repayment amount that needs to be inserted in the contract. |
| decreaseInstallment | Mandatory. Possible values: true or false. Passing true keeps the contract period length, passing false decreases the contract period length. |
| repaymentFeeValue | The value of the repayment fee, used to calculate the final early repayment value. If the value is not sent and the banking product has a Repayment Fee type commission, the system calculates it based on the repaymentFeePercent, which is mandatory in this case. If there is no Repayment Fee type commission at the banking product level, then an error is returned saying You do not have any repayment fee registered on the banking product. |
| repaymentFeePercent | The percent of the repayment fee, used to calculate the final early repayment value. If the percentage is not sent and the banking product has a Repayment Fee type commission, the system calculates it based on the repaymentFeeValue, which is mandatory in this case. If there is no Repayment Fee type commission at the banking product level, then an error is returned saying You do not have any repayment fee registered on the banking product. |
| externalIdentifier | Optional, string. The external identifier of the transaction. |
| collectAccruedInterest | Optional, boolean. For True value, Loan Management collects the accrued interest. The default value when the value of the parameter is not sent is False. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the FTOS_CB_ContractEvent entity . The entire repayment schedule is recalculated considering this event.
Example
Adding a New Early Repayment Event for a Contract
To create a new record in the FTOS_CB_ContractEvent entity, do not send the eventName with the request.
Request
POST https://FintechOSStudio/ftosapi/automation-processors/actions/FTOS_CB_AddUpdateEarlyRepayment
Content-Type: application/json
{
"contractName":"3271",
"baseAmount":1100,
"decreaseInstallment":false,
"repaymentFeePercent":4.5,
"externalIdentifier":"TR99990077963",
"collectAccruedInterest":false
}Response
{
"MinimumPrincipal":1100.00,
"RepaymentFee":49.50,
"RepaymentFeePercent":4.5000,
"MaxInstallmentNo":11,
"InterestValue":0.00,
"OtherFees":0.00,
"TotalRepaymentValue":1149.50,
"UnpaidDepts":0.00,
"CustomerUnpaidDepts":20451.64,
"FeeIsPercent":false,
"MaxPrincipal":6613.44,
"IsEqualInstallment":true,
"InstallmentValue":513.67,
"Nper":1,
"PrincipalValue":0.00,
"FuturePrincipal":6613.44,
"MinDueDate":"2021-11-11T00:00:00Z",
"RepaymentFeeId":null,
"AccruedInterest":0,
"EventId":"008b701a-6fe7-45f5-8de0-035f583e2d0b",
"EventName":"ECB2205",
"RepaymentSchedule":null,
"WarningMessage":"Warning - base amount is lower than minimum early repayment amount set on product",
"isSuccess": true
}
To update an existing record in the FTOS_CB_ContractEvent entity, the eventName must be sent with the request.
Request
POST https://FintechOSStudio/ftosapi/automation-processors/actions/FTOS_CB_AddUpdateEarlyRepayment
Content-Type: application/json
{
"contractName":"3271",
"eventName":"ECB2205",
"baseAmount":1500,
"decreaseInstallment":false,
"repaymentFeePercent":4.5
}Response
{
"MinimumPrincipal":1500.00,
"RepaymentFee":67.50,
"RepaymentFeePercent":4.5000,
"MaxInstallmentNo":11,
"InterestValue":0.00,
"OtherFees":0.00,
"TotalRepaymentValue":1567.50,
"UnpaidDepts":0.00,
"CustomerUnpaidDepts":20451.64,
"FeeIsPercent":false,
"MaxPrincipal":6613.44,
"IsEqualInstallment":true,
"InstallmentValue":476.40,
"Nper":1,
"PrincipalValue":0.00,
"FuturePrincipal":6613.44,
"MinDueDate":"2021-11-11T00:00:00Z",
"RepaymentFeeId":null,
"RepaymentSchedule":null,
"warningMessage":"Warning - base amount is lower than minimum early repayment amount set on product",
"isSuccess": true
}
Error Responses
-
Bad Request - Contract name is null- the request does not contain a contract number; -
Bad Request - Base amount is null- the request does not contain a repayment amount; -
Bad Request - fee value and fee percent are both defined but they do not match- fee value and percent do not match; -
Event is already approved and cannot be modified- you cannot update already approved contract event records; -
No contract found for contract name:- the contract number sent with the request cannot be found in the system. -
You do not have any repayment fee registered on the banking product- there is noRepayment Feetype commission defined at the banking product level, but the request contains arepaymentFeeValueand/ or arepaymentFeePercentparameter different than zero.