Loans
Record a payoff quote
Record the figure that discharges a Loan on a date, because you are about to relay it, and receive it with the record’s identifier.
POST
Ask for this when you tell a borrower “pay this to end the loan”. The Platform derives what discharges the Loan on the date you name — exactly as the payment options do, one derivation and one number — records it with the versions of what computed it, and answers the figure with the record’s
id. The Receipt that pays it may name that id in quote_id, and its allocation then says whether the money was the recorded figure.
The record binds nothing. No settlement cites it: a Receipt is settled against the figure derived on its value date, whatever was recorded. What the record is for is the day a later answer moves — a Receipt with an earlier value date arrives, a release changes the calendar — and you need to show what the Platform said and what said it. Every record is listed on the Loan’s payoff quotes.
The payment options record nothing. They answer the same figure for a screen, as often as a screen is drawn. Record only what you relay: each request records again, because asking twice is two acts of saying, and the second answer may differ.
Path parameters
string
required
The Tenancy the Loan belongs to.
string
required
The Loan, as the issuance answered it. Another Tenancy’s and one that never existed are both
404.Body
string
required
The date the figure answers for,
YYYY-MM-DD — which may be one that has not arrived, “what if I pay on Friday”. Required and never defaulted. The figure itself is the Platform’s to derive: a body stating one is refused.Response
201 with the record:
string
required
The Loan.
string
required
The record’s identifier — what a Receipt paying it names in
quote_id.string
required
The date the figure answers for: the
on you named.string
required
RFC 3339 in UTC: the moment the Platform said it.
object
required
What discharges the Loan on
quoted_for, as minor_units and currency — the payment options’ payoff.owed total for the same date, to the minor unit.object
required
The three versions that produced it:
engine, calendar, country. What each names.string
required
The sentence every listing of quotes carries: a recorded quote is evidence of what was said, never authority over what is owed.
Refusals
A refused recording records nothing.