List loans [Beta]

List loans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Next page cursor

boolean

Retrieve the present value of the loan?

int32
≤ 50

Maximum returned list size. Default = 10.

string
enum

Loan status

PENDING-The loan has been created but has not yet been booked. Terms may still be under review or awaiting confirmation. BOOKED-The loan has been approved and booked. The payment schedule is confirmed and the loan is ready for disbursement. ACTIVE-The loan is active and in progress. Funds have been disbursed and the borrower is expected to make repayments according to the agreed schedule. CANCELED-A repayment is no longer expected to be paid. SETTLED-The loan has been fully repaid and is closed. No further repayments are expected. RENEGOTIATED-The original loan terms have been modified after booking, typically due to a change in repayment conditions or borrower circumstances. SCHEDULED-A repayment is expected to be paid on or before the due date of the repayment. PROCESSING-An intermediate state that happens whenever there are asynchronous process that demand a state change. For example, BOOKING → PROCESSING → ACTIVE. Common use case - A repayment registration has just been requested using the Register repayment endpoint and is being processed. PAID-The expected repayment amount has been paid in full on or before the due date of the repayment. PARTIALLY_PAID-Only part of the expected payment amount has been paid. However, the repayment due date has not passed, so the borrower could still make the full payment on time. PAST_DUE-The repayment due date has passed and the expected repayment amount has not been paid in full. NOT_PAID-An attempt to execute an auto repayment for this installment was not successful.

string
length ≤ 80

Loan product ID. Accepts either a lowercase UUID (e.g., "2717a296-124a-47cc-b2a1-91e80dc723eb") or an uppercase alphanumeric string with underscores (e.g., "MY_LOAN_PRODUCT_001"). If not provided during creation, a UUID is auto-generated.

int64

Account ID

boolean

Include information about scheduled repayments in the response?

number

Authorization ID that originated the loan

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json