Loans
Preview a loan
Quote the agreement before recording it: the same body an issuance takes, priced identically, with nothing recorded.
POST
A preview reads the body an issuance takes, runs every check issuance runs, prices the plan the same way, and records nothing.
reference is ignored here and required on the issuance; every other field behaves identically, so a preview that answered 200 is a body issuance will accept.
Loans carries what is checked and what the answer freezes; Pricing carries the arithmetic. The wire form of every value is on Model.
Path parameters
string
required
The Tenancy previewing. A key for another Tenancy answers
403.Body
The issuance body,reference ignored. The fields are documented once, on Issue a loan; the checks run in the same order, the Client first — an unregistered client_id refuses a preview exactly as it refuses an issuance.
Response
200 with the quote: the same document an issuance answers, without id, state or events — nothing exists to carry them.
object
required
The Configuration the quote priced under, pinned as
{id, version}.object
required
The stated terms, echoed.
array
required
The plan: every Period’s
scheduled_on, due_on, principal, interest, fee, tax and the derived payment.object
required
The jurisdiction and the disclosed cost figure — the CAT, in
MX — and the convention that produced it.The CAT in
MX is provisional today, so a preview reads provisional: true. Printing a figure under a provisional rule is your decision; what that means.object
required
The jurisdiction’s law as values: penalty rate, late fee, tolerance, penalty base, capitalisation, the acceleration conditions.What the preview shows here is what issuance freezes, field for field — the tolerance band as
tolerance and each penalty ceiling as penalty_ceiling_days and penalty_ceiling_bps, each served only where the product states one. The read says what each absence means.A preview binds nothing. No figure served by one constrains a later issuance, and pricing runs once more at issuance on the same inputs — the two answers are identical.
Refusals
Everything issuance refuses, with one difference: noreference means no reference_reused and no retry semantics — previewing twice writes nothing twice.