Instalments

List instalment loans by account id.

Retrieves all instalment loans for an account

get/instalment-loans

Request

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

Query parameters

account_idinteger required

Headers

unique-request-idstring

Unique identifier of a request.

Response

Retrieved all instalment loans for the account successfully.

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.