Skip to main content
GET
Read a loan with its pending instructions

Authorizations

Authorization
string
header
required

Token from POST /v1/oauth/token (client credentials)

Path Parameters

loan_id
string<uuid>
required

Response

The loan view

loan_id
string<uuid>
required
status
string
required
currency
enum<string>
required
Available options:
USD
principal_cents
integer
required
interest_cents
integer
required
hold_cents
integer
required
outstanding_cents
integer
required

Contractual balance, the sum of amount due less amount paid over the current installments. It is 0 while the loan is pending_disbursement or cancelled, because nothing is owed until the payout is confirmed; each installment's amount_due_cents still shows the schedule.

installments
object[]
required
instructions
object[]
required

Pending instructions only, oldest first.

deduction
object | null
required

The stored deduction instruction, never recomputed; null until the first payout.