Loans
List the loans
Every loan of the tenancy, or one client’s, each row a summary with the folded state on it.
GET
The collection answers summary rows, newest first — enough to find a Loan and see what it is, with the full record one read away. The row carries the folded
Any other parameter — unknown, repeated, or valueless — is
state, and a state that stops the Loan carries its date beside it: a ceded row reads ceded_on. It also carries the contract as issued — rate, fee, penalty_rate and the plan’s total of payments — and what the receipts did: paid, the settled and remaining Periods, and whether the Loan still owes and to whom. A catalogue of credits prints from the row without a second read.
Four narrowings: by Client, by Product configuration, by merchant, and by state.
Path parameters
string
required
The Tenancy listing.
Query parameters
string
One Client’s Loans only.
string
One Product configuration’s Loans only — every version of it, since a Loan names the version it was issued under and the narrowing is by product.
string
The Loans issued naming one merchant only. A Loan that names none is on no merchant’s listing. What the merchant is owed over a period is the merchant’s book.
string
One folded state only:
active, cancelled, closed, written_off, ceded, held, expired, voided, rescinded, withdrawn or restructured.A Loan issued with a hold and not confirmed — held, expired, or voided before it was signed — is listed only when this filter names one of those three. A listing that names none reads the book as it read before holds existed. expired needs on.The state is derived rather than stored, so this filter narrows the book and not the page: the walk reads past rows that do not match until the page fills. The work one request may do is bounded at ten times limit rows examined, so a filtered page may come back short — or empty — carrying a cursor. Read the section below before you treat a short page as the end.string
The date a hold is judged against: a hold whose
hold_until this date is after reads expired. Without it an unconfirmed hold reads held — there is no today to judge it by.integer
default:"50"
How many rows to serve, between 1 and 200. A value outside that range is
400, never clamped.string
Where to resume, returned verbatim from the previous page.
400 invalid_query. So is a state this platform does not fold to, and a client_id, configuration_id or merchant_ref that is not an identifier.
Walking a filtered listing
Understate, a cursor says the walk continues and nothing about whether another matching Loan exists. A page can be empty and still carry one, which means the request spent its budget of rows before it found a match — send the cursor back and the walk carries on from there.
The listing ends when a page arrives without a cursor. That is the only end signal, on this route and on every other: never read the end from the length of a page.
Response
array
required
The rows.
string
Where the next page resumes. Present whenever the walk continues — under
state a page may be short or empty and still carry one — and absent exactly at the end of the listing.