List a borrowing's repayments through its lender, oldest first
/ledger/borrowings/{id}/lender-repaymentsA read needs ledger:read or ledger:post.
Path parameters
idstringRequiredReturns
200 OK
dataarray of objectsRequired13 child attributes
actorstringRequiredborrowing_idstringRequiredconfirmationobject or nullOptionalDocument is every signed answer the lender gives, one payload per kind.
13 child attributes
advanceobject or nullOptionalAdvanceConfirmation is the lender's answer to an advance request: made, with the terms it was made on, or declined with the reason.
11 child attributes
advance_numberstringOptionalavailable_amountintegerRequiredThe collateral value available before the advance
day_count_basisstringRequiredActual/365 or actual/360
maturity_datestring · dateRequiredA business date, YYYY-MM-DD
principal_amountintegerRequiredprogramstringRequiredrate_bpsintegerRequiredreasonstringOptionalreferencestringRequiredstatusstringRequiredMade or declined
value_datestring · dateRequiredA business date, YYYY-MM-DD
borrowerstringRequiredThe bank as the lender names it
collateralobject or nullOptionalCollateralDecision answers a collateral submission item by item.
3 child attributes
actionstringRequireditemsarray of objectsRequiredreferencestringRequiredissued_atstring · date-timeRequiredissuerstringRequiredThe Reserve Bank or the Federal Home Loan Bank
key_idstringRequiredkindstringRequiredlenderstringRequiredrepaymentobject or nullOptionalRepaymentConfirmation is the lender's answer to a repayment request: the principal repaid, the interest charged on the advance for the days since interest was last paid, any fee, and the total debited to the bank.
13 child attributes
advance_numberstringRequiredfee_amountintegerRequiredinterest_amountintegerRequiredinterest_fromstring · dateRequiredA business date, YYYY-MM-DD
interest_throughstring · dateRequiredA business date, YYYY-MM-DD
principal_amountintegerRequiredprincipal_outstanding_amountintegerRequiredrate_bpsintegerRequiredreasonstringOptionalreferencestringRequiredstatusstringRequiredRepaid or refused
total_amountintegerRequiredvalue_datestring · dateRequiredA business date, YYYY-MM-DD
scheduleobject or nullOptionalCollateralSchedule is the lender's collateral schedule in force from a date.
3 child attributes
classesarray of objectsRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
sourcestringRequiredsignaturestringRequiredstatementobject or nullOptionalCollateralStatement is the lender's collateral valuation and margin statement at the close of a day: every item, the total lendable value, the principal of advances outstanding, the interest accrued on them and unpaid, and what remains available. Collateral secures the interest as well as the principal: a Reserve Bank's Advance Repayment Amount is the advance plus accrued interest, and its security interest secures all Obligations (Operating Circular No. 10, 2.1 and 6.0), so the available value is the lendable value less both.
7 child attributes
accrued_interest_amountintegerRequiredadvancesarray of objectsRequiredadvances_outstanding_amountintegerRequiredas_ofstring · dateRequiredA business date, YYYY-MM-DD
available_amountintegerRequireditemsarray of objectsRequiredlendable_amountintegerRequiredversionstringRequiredidintegerRequiredinterest_amountintegerRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
lender_advance_idintegerRequiredprincipal_amountintegerRequiredreasonstringOptionalrecorded_atstring · date-timeRequiredsentobjectRequiredRepaymentRequest repays principal of an advance, with the interest the lender charges on it.
7 child attributes
advance_numberstringRequiredborrowerstringRequiredlenderstringRequiredprincipal_amountintegerRequiredreferencestringRequiredvalue_datestring · dateRequiredA business date, YYYY-MM-DD
versionstringRequiredstatusstringRequiredRequesting, refused or booked
updated_atstring · date-timeRequiredhas_morebooleanRequiredWhether another page follows
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503