Credit policy
Adopt a policy version
Name the Credit policy version the applications for one Configuration are decided under, and receive it back with the moment it was recorded.
PUT
This call records which policy version the applications naming one Configuration are decided under — a Platform pack, or one your Tenancy published and a second person confirmed. On a sandbox Tenancy the publisher’s own confirmation is enough. Until you make it for a Configuration, nothing is adopted there and every application naming it is refused.
Adoption is per Configuration. You hold one adoption per product, and the same version may be adopted for several: a Tenancy selling payday at 300% and instalment at 60% judges the two books by two policies, because a policy whose approving bands fall inside one rate corridor falls outside the other.
Adopting is a statement, not a switch. The Platform records the moment; applications naming that Configuration submitted after it are decided under the version you named, and every Decision already recorded keeps the version it names.
Nothing is adopted by default or by silence. The policy you refuse your own clients under has to be one somebody at your company chose, and chose for that product.
Path parameters
string
required
The Tenancy adopting. Another Tenancy’s path answers
403.string
required
The Configuration this adoption governs. A Configuration your Tenancy does not have is refused naming it.
Body
string
required
A policy you may decide under, by name: a Platform pack such as
mx-base, or one your Tenancy published. The list call answers both.integer
required
One of that policy’s versions, counting from 1. A version of your own that nobody has confirmed is refused.
boolean
default:"false"
Whether the Platform holds the credit bar for this Configuration. With
true, an application for a Client a recorded refusal bars on the day the application states is refused with 409 client_barred, before any source is read. Nothing is recorded for it, so the bar does not restart. Omitted or false, the bar is answered and not enforced.Response
string
required
The Configuration this adoption governs.
string
required
The policy adopted.
integer
required
The version adopted.
boolean
required
Whether the Platform holds the credit bar for this Configuration.
string
required
RFC 3339 in UTC: the moment the Platform recorded the statement.
Correcting an adoption
Adopt again for the same Configuration. The latest statement for that Configuration governs, and the one before it stays where it was — underneath, a correction is a further row rather than a rewritten one. An adoption for one Configuration never disturbs another’s. No call answers any adoption but the current one, per Configuration. What the earlier ones governed is readable through the Decisions that recorded them: each names the policy and version it was decided under, and that never moves.Refusals
This route reads no query parameter.
A refused adoption changes nothing: the adoption you already hold for that Configuration still governs, so a mistyped version number does not stop you deciding.