API Documentation

Register a payment holiday for a precomputed loan

post
https://apim.demo01.my.fivedegrees.cloud/lending/precomputed-loans//payment-holidays

API endpoint to register a payment holiday on a pre-computed loan and prolong if needed, the applicable payments will get the status DELAYED, and the delayed amount is distributed over future UNPAID cashflows.

Path Params
uuid
required

Format - uuid. Identifier (GUID) of the loan.

Body Params

Create payment holiday request

Create payment holiday for loan

date
required

The date on which the payment holiday begins. Any payment on and after this date will be delayed. The date can be today or in the future, but cannot be after the end date loan or the period end date.

date
required

The resume date is the first date expected to resume payment. Any payment on and after this date will not be marked delayed.

date | null

A new end date for the loan if needed.

string | null

This setting affects the cash flows that reside within the payment holiday (delay) period. In the reference data endpoint 'precomputed-holiday-type' a user can get the full list of available values.

string | null

This defines how the delayed cashflows will be redistributed accross the loan. In the reference data endpoint 'precomputed-repayment-type' a user can get the full list of available values.

double | null

A fixed amount payment holiday will require the borrower to pay a smaller fixed amount during the duration of the holiday. If the fixed amount type is selected, also an amount that the borrower will have to pay for each cashflow date during the payment holiday need to be entered. The defined fixed amount will be the total amount of the cashflow, and will therefore be allocated across any applicable fees, penalties, interest, and principal.

string | null

Optionally, if the loan is in default, you can choose to include the arrears in the payment holiday cashflow recalculation. If enabled, all payments in arrears will be set to zero (or down to what has already been paid), and any outstanding balance will be reallocated to future cashflows depending on the repayment type selected.

string | null

A comment (text) can be entered.

Headers
string
uuid
required

Format - uuid. Correlates HTTP requests between a client and server

Responses
202

Accepted

500

Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?