Loans
Issue a loan
Record the agreement: the terms are checked against the configuration, priced once, and frozen with the loan.
POST
Issuance records the agreement and answers
201 with the Loan as every later read answers it: the folded state, the recorded events, the plan and the regime — priced once, frozen forever. Loans carries the checks and the freeze; Preview takes this same body and records nothing.
The reference is the retry: an issuance retried under it with the same statements answers 200 and the Loan on file, never a second Loan.
Path parameters
string
required
The Tenancy issuing. A key for another Tenancy answers
403.Body
string
required
Your own identifier for the agreement, unique within the Tenancy. 1–64 characters of
a–z A–Z 0–9 - _.string
required
A registered Client — checked before anything else, preview included.
string
required
The Configuration the Loan is sold under.
integer
required
The version, pinned. The word
latest is refused by name: a Loan issued against whatever is newest is a Loan issued under terms nobody stated.object
required
The amount lent:
{"minor_units": 800000, "currency": "MXN"}. Inside the Configuration’s principal range, in its currency.integer
required
How many Periods the Loan repays over. A member of the Configuration’s
terms menu; 1 on a payday product, whose menu is locked.string
The annual nominal rate, a decimal percentage in a string:
"45.5". Inside the Configuration’s rate corridor. Optional under a Facility: omitted, the Loan takes the Facility’s rate exactly — the rate.percent the Facility and its decision read — and a stated rate is compared with it exactly, refused facility_rate where it differs. A retry is compared on the rate the Loan resolves to, so omitting the rate and stating the Facility’s are one issuance under one reference. Required with no Facility, refused invalid_rate when omitted.string
The lateness rate, quoted the same way. Inside the penalty corridor, and at or under the jurisdiction’s cap — in
MX, twice the Loan’s own ordinary rate; the market’s rules state the cap’s form. Optional where the version’s penalty corridor is a single point (penalty_rate_min equal to penalty_rate_max): the Loan takes the point, held to the cap exactly as a stated rate is. Required under a corridor whose ends differ, refused missing_term when omitted.string
required
The civil date the agreement runs from,
YYYY-MM-DD. Never compared to a clock: a backdated anchor is legitimate.string
required
ISO 3166-1 alpha-2, with up to two subdivisions:
MX, DE-BY. It selects the market’s rules, and a jurisdiction the rule tables do not cover refuses issuance.object
required
The tax rule:
{"rate": "16", "on": ["interest", "fee", "penalty", "late_fee"]}. It must be one of the rules the jurisdiction admits, rate and components compared whole, in any order: Markets lists them, and the country registry serves them as tax_rules. A component the version can never charge may be left out. No default and no omission — an exempt borrower is a rule of zero, stated. Principal is never taxed.object
The collection at the purchase. Required on
bnpl, meaningless elsewhere.object
Which of the version’s admitted schedules the Loan collects on:
{"kind": "semi_monthly_grid"}, or {"kind": "monthly_on_day", "day": 20} — the day is required under monthly_on_day and refused under every other kind. Required where the version admits several schedules, optional where it admits one. The interval and the grid days are the version’s and are not restated. The anchor keeps its meaning: the credit runs from it and interest accrues from it; the choice moves only where the payments fall, so a loan anchored on the 9th charging on the 20th collects first on the 20th of the same month.string
The Facility to draw from — required where the Configuration version requires a grant, and held to it: the Client, the product, the currency, the rate, the window and the headroom are each checked against the grant.
string
The Credit Decision this plan is priced under, recorded with the Loan. A Decision taken on another Client, another product or another principal is refused.
string
Your own key for the store, counter or biller the Loan financed a purchase at — letters, digits, hyphen and underscore, 1 to 64. Optional: a Loan that names none is on no merchant’s book. Recorded on the Loan, echoed on every read of it and on every feed entry about it, a filter on the listing, and the key the merchant’s book is read by. The platform reads nothing from it and holds nothing about the merchant. A retry restates it.
string
The last day the Loan may be confirmed on, for an issuance that waits for a signature; on or after
anchor. Until confirmed the Loan is held: every term and period is fixed and it draws its grant, but it owes nothing, takes no money and counts toward no figure about the Client. Past this day it reads expired and admits only a void, which gives the grant and the reference back. Refused on a product collecting a payment at the purchase. A retry restates it.object
Your key-value object: at most 16 keys, 64 bytes a key, 4096 bytes rendered, string values. Stored, echoed on every read, read by nothing — and part of what a reused
reference restates.Response
201 with the Loan; Read a loan documents every field of it. A retry with the same reference and the same statements answers 200 and the same Loan.