PApaymentology
Instalments

Get instalment illustration by transaction reference

This API call triggers real time creation of an instalment loan illustration

get/instalment-illustrations/reference/{transaction_reference}

Request

  • Base URL
    http://<host-url>
  • URL
    http://<host-url>/instalment-illustrations/reference/{transaction_reference}
  • Auth
    HTTP bearer

Path parameters

transaction_referencestring required

Headers

unique-request-idstring

Unique identifier of a request.

Response

Generated loan illustrations successfully.

account_idinteger

Account ID

amount_per_cyclenumber

Repayment amount per cycle

cancellation_fee_amountnumber

The fixed fee amount for cancelling the instalment loan, if configured

cancellation_fee_calculation'HIGHER' | 'LOWER'

HIGHER or LOWER, determines whether higher or lower of cancellation amount or cancellation percentage is charged

cancellation_fee_percentagenumber

The cancellation fee calculated as a percentage of the outstanding instalment loan, if configured

eligible_transaction_referencestring

The eligible transaction on which this illustration is based

first_repayment_datestring date

First repayment due date

idinteger

Illustration ID

instalment_finance_optioninteger

Finance option ID

interest_calculation_method'FLAT' | 'REDUCING_BALANCE'

Flat or reducing balance

interest_ratenumber

Interest rate percentage

last_repayment_datestring date

Last repayment due date

late_fee_amountnumber

The late payment fee fixed amount, if configured

late_fee_calculation'HIGHER' | 'LOWER'

HIGHER or LOWER, determines whether higher or lower of late payment amount or late payment percentage is charged

late_fee_percentagenumber

The late payment fee calculated as a percentage of the loan amount, if configured

merchant_category_codestring

Not currently in use

merchant_namestring

Not currently in use

number_cyclesinteger

Number of cycles or the loan tenure

processing_feenumber

The one off processing fee, if configured

product_idinteger

Product ID

termination_fee_amountnumber

The fixed fee amount for termination of the instalment loan, if configured

termination_fee_calculation'HIGHER' | 'LOWER'

HIGHER or LOWER, determines whether higher or lower of termination amount or termination percentage is charged

termination_fee_percentagenumber

The termination payment fee calculated as a percentage of the loan amount, if configured

total_interestnumber

Total interest for the loan

total_principalnumber

Loan amount

Changes

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