Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
u) Loan Functionality

Get loan transactions

Retrieves the transaction history for a loan, with optional date range, filter, and external ID search parameters.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/loans/{loanId}/transactions

Path parameters

tenantIdinteger required
loanIdinteger required

Query parameters

dateFromInclstring

Start of the date range (inclusive). ISO date string.

dateToExclstring

End of the date range (exclusive). ISO date string.

externalIdstring

External ID from the originating request. Overrides other filters when supplied.

externalUniqueIdstring

External unique ID from the originating request. Overrides other filters; prefix with CR- or DB- to target the credit or debit leg.

filterstring

Free-text filter applied across transaction fields. Case-insensitive.

limitinteger
offsetinteger

Response

OK

amountnumber

Amount. Negative for debits, positive for credits. Amounts are in major currency unit

authorisationCodestring

Auth code for card transactions

balancenumber

This refers to the total amount that is currently owed on a loan, including any unpaid principal, interest. It is the amount that the borrower would have to pay in full to pay off the loan at the present time

currencystring

Currency of the transaction. E.g. USD, ZAR, NGN etc

datestring date-time

ISO 8601 of the transaction

descriptionstring

Transaction description

externalIdstring

External identifier for the transaction which can be used for reconciliation. Need not be unique

externalUniqueIdstring

The externally provided unique identifier for the transaction

feenumber

Fee. The additional fee charged as part of the transaction

interestnumber

The interest amount accrued on the loan, expressed as a decimal value. This is the total amount of interest charged on the loan over a given period of time

interestRatenumber

The interest rate assigned to the loan, expressed as a decimal value. The rate is the amount of interest that the customer will pay on top of the loan principal over a given period of time

principlenumber

The principal amount of the loan, expressed as a decimal value. This is the initial amount of money borrowed by the customer, and it does not include any interest or fees charged by the lender

transactionIdstring required

Unique identifier for the transaction generated by the loan system

typestring

Transaction type

walletIdinteger required

A walletId representing the id of the customer's wallet where the loan amount will be credited or debited when making payments on the loan

Example response

[
  {
    "date": "2022-03-10T12:15:50-04:00",
    "payment": {
      "created": "2022-03-10T12:15:50-04:00",
      "expires": "2022-03-10T12:15:50-04:00",
      "lastModified": "2022-03-10T12:15:50-04:00"
    }
  }
]