Markets
Read a market's rules
Every rule a term or a grant is refused under in a market — the penalty cap, the base, capitalisation, the late fee beside a penalty, acceleration, the taxes, the disclosure, the calendar and the facility window — each with whose rule it is and whether it is provisional.
GET
The rules a Loan issued in a jurisdiction is held to, before a refusal teaches them to you. Each is read from the table the Platform enforces it from, so what this answers is what a refusal enforces — and when a reading moves, both move in the same release.
Every rule carries two marks:
A rule the Platform supplies nothing for in the market is absent rather than empty. Any query parameter on this route answers
The answer is the same under every Tenancy and reads nothing yours. It is addressed under a Tenancy so that the console and the API serve it alike.
Path parameters
string
required
The Tenancy asking. The answer does not depend on it.
string
required
A country,
MX, or a subdivision of one, MX-JAL. A subdivision with nothing of its own answers its country’s rules. One the Platform supplies nothing for is 404 not_found, naming it — never a default.Response
string
required
As asked.
string
required
Whose rules answered: the country, for a subdivision.
boolean
required
Whether the Platform lends in the country at all. A market read only in part —
ES has its tax read and nothing else — answers what is read and false here.object
The ceiling on a penalty rate, as its form: at an ordinary rate of
r, r × multiple + spread. multiple is an exact {numerator, denominator}; spread and at_zero_rate are percentages. In MX the multiple is two and the spread zero, so a Loan at 30% caps its penalty at 60%, and a Loan at 0% admits a penalty rate of 0% — an interest-free product charges for lateness with a late fee. A preview or issuance above the cap is refused penalty_rate_above_cap, with the cap at the Loan’s own rate in details.bound.object
base: what a penalty accrues on — overdue_principal, the overdue period’s own unpaid principal, or outstanding_principal.object
admitted: whether unpaid interest, fees, tax and penalties may enter the penalty base.object
admitted: whether a Loan may carry a late fee beside a penalty rate above zero. In MX it may not — one delay is charged once — and issuance refuses the pair late_fee_beside_penalty: a version charges lateness with one or the other.object
When a balance may be called:
forbidden, missed_periods that must stand overdue, and notice_days of notice before it.object
rules: the tax rules a Loan may bear, in the shape an issuance states tax in, the general case first — the same list the console’s country registry answers. Issuance refuses any other.object
The convention a Loan’s disclosure figure is computed under —
convention, version, status — as the figure on a Loan issued today names it. provisional follows status.object
horizon: the last civil date the market’s calendar covers. A schedule reaching past it is refused beyond_horizon, with this date in details.bound. It moves out with releases, and is data rather than a reading of law, so it is never provisional.object
required
The Platform’s own bound, the same in every market:
days from the granting decision’s day a one-draw Facility may stay drawable, line_days for a line, each with its basis. A window past it is refused outside_window_bound, with the bound in details.bound.400: the route reads none.