Instalments

Create instalment loan amendment

Executes an instalment amendment based on a previously generated amendment illustration. Closes the existing loan, marks it Amended, and creates a new loan from the illustration.

post/instalment-loans/amendment

Request

Base URL
http://<host-url>
URL
http://<host-url>/instalment-loans/amendment
Auth
HTTP bearer

Headers

unique-request-idstring

Unique identifier of a request.

Request body

illustration_idinteger required

The illustration ID to base the amendment on

Response

Amendment executed successfully. Returns the newly created instalment loan.

cycle_amountnumber

Repayment amount per cycle

cyclesinteger

Number of cycles or the loan tenure

end_datestring date

End date of loan

first_repayment_datestring date

First repayment due date

idinteger

Instalment loan ID

illustration_idinteger

Illustration ID

instalment_interestnumber

Total interest for the loan

instalment_principalnumber

Loan amount

last_repayment_datestring date

Final repayment due date

pending_cyclesinteger

Remaining number of cycles

pending_interestnumber

Outstanding interest for the loan

pending_principalnumber

Outstanding loan amount due

processing_feenumber

The one off processing fee, if configured

product_idinteger

Product ID

start_datestring date

Start date of loan

status'ACTIVE' | 'INACTIVE' | 'DELETED' | 'CLOSED' | 'AMENDED'

Loan status

Changes

No recorded changes to this operation across all 1 revision of this API.