Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
u) Loan Functionality

Get a loan by ID

Retrieves loan details for a specific loan.

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

Path parameters

tenantIdinteger required
loanIdinteger required

Response

OK

amountnumber

Representing the loan amount requested by the customer

callbackUrlstring

The URL Eclipse must post the LoanResult to when the loan is either approved or un approved. Optional as one can always do a GET to get the result instead of using callbacks. This will be a system-system call

createdstring date-time

When the loan was posted

currencystring required

The currency of the wallet - e.g. USD, ZAR, NGN, TSH

currentBalancenumber

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

customerIdinteger
descriptionstring

Loan Description

errorDescriptionstring

Loan Error Description

externalUniqueIdstring

A globally unique identifier

feenumber

The fees applicable on choosen loan provider and loan product

interestRatenumber

Representing the interest rate based on choosen loan provider and product

lastModifiedstring date-time

When the loan was last modified

loanIdinteger

A unique system generated numeric identifier for the loan

maxLoanAmountnumber

The maximum amount that can be loaned with this to this customer

minLoanAmountnumber

The minimum amount that can be loaned with this to this customer

providerstring

Loan provider

status'ACTIVE' | 'APPROVED' | 'BUILDING' | 'CANCELLED' | 'ERROR_PERM' | 'PAID_OFF' | 'PENDING' | 'UNAPPROVED'

Status of a Loan: BUILDING: The loan application has been received but not yet reviewed, PENDING: The loan application is under review, APPROVED: The loan application has been approved, ACTIVE: The loan amount has been disbursed to the borrower, DEFAULT: The borrower has failed to make payments for an extended period, and the loan is in default status. UNAPPROVED: The loan application has been unapproved, PAID_OFF: The loan has been fully paid off by the customer, CANCELLED: The customer has canceled the loan application before it was approved or funded. ERROR_PERM: Loan application is not successful

walletIdinteger

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

{
  "created": "2022-03-10T12:15:50-04:00",
  "lastModified": "2022-03-10T12:15:50-04:00"
}