Loans
Read the serviced schedule
The plan as it stands on a date: what each period still remains owed, the day each settled one settled, and every recomputation applied.
GET
The Loan’s own
The first example is the worked Loan after its statutory prepayment: Period 1 settled, the rest recalculated to 67014 (MXN 670.14). The second is a rolled payday Loan: the original Period settled by the roll, index 2 the settlement it charged — interest and the rollover fee — and index 3 the segment carrying the principal forward.
periods[] are frozen at issuance; the serviced Schedule is where the Loan stands now — a prepayment’s recalculated figures, a rollover’s segment, and per Period what remains and what settled when. Payments works the recalculation through; Products works the rollover.
A validator. The answer carries an ETag over the Loan’s Client’s book and the date — the schedule and the delinquency are folded from every Receipt of the Client, so anything recorded about the Client moves it. Send it back in If-None-Match and an unchanged book on the same date is answered 304 with no body, before anything is derived, as on the payment options.
Path parameters
string
required
The Tenancy the Loan belongs to.
string
required
The Loan. Another Tenancy’s and one that never existed are both
404.Query parameters
string
required
The civil date the answer stands as of,
YYYY-MM-DD. Required and never defaulted — the Platform supplies no today. Absent is 422.Response
string
required
The Loan, and
reference beside it.string
required
The date the answer is as of, echoed.
array
required
Every Period the Loan services on that date — the issued ones at their current figures, a rollover’s settlement and segment included.