Repay principal of an advance drawn through its lender's connection: the lender charges the interest owed and the confirmation books principal, interest and cash in one journal (treasury staff)
/ledger/borrowings/{id}/lender-repaymentsThe ledger's guard admits ledger:treasury:write; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The lender is a simulator reached through the lender kind's configured connection; a kind with none answers 424 dependency_failed. Only an advance drawn through a lender connection, else 409 conflict; principal beyond what is outstanding is 409. The lender's confirmation books, in one journal, the advance's liability for principal and the interest recognised from its statements, interest on borrowings (GL 5200) for the lender's charge beyond that, and the master account (GL 1010) for what the lender debited; the last dollar marks the borrowing repaid. A refusal is retained with the lender's reason. One repayment in flight per advance; a lost confirmation is 424 dependency_failed and the same key resends.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
principal_amountintegerRequiredReturns
200 OK
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 objectsRequired7 child attributes
item_referencestringOptionalkindstringRequiredLoan or security
operator_referencestringOptionalThe Fedwire Securities transfer of a pledge or a release
par_amountintegerOptionalreasonstringOptionalreferencestringRequiredThe loan id or the CUSIP
statusstringRequiredAccepted, refused, withdrawn or released
referencestringRequiredissued_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 objectsRequired6 child attributes
asset_classstringRequiredeligiblebooleanRequiredmargin_bpsintegerRequiredThe share of the basis lent against
max_days_past_dueintegerOptionalpledge_methodstringOptionalRestricted_account, borrower_in_custody, listing, delivery
valuation_basisstringOptionalMarket_value or unpaid_principal
effective_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 objectsRequired7 child attributes
accrued_interest_amountintegerRequiredadvance_numberstringRequiredmaturity_datestring · dateRequiredA business date, YYYY-MM-DD
principal_amountintegerRequiredprogramstringRequiredrate_bpsintegerRequiredvalue_datestring · dateRequiredA business date, YYYY-MM-DD
advances_outstanding_amountintegerRequiredas_ofstring · dateRequiredA business date, YYYY-MM-DD
available_amountintegerRequireditemsarray of objectsRequired11 child attributes
asset_classstringRequiredbasis_value_amountintegerRequiredeligiblebooleanRequiredineligible_reasonstringOptionalkindstringRequiredlendable_amountintegerRequiredmargin_bpsintegerRequiredThe share of the basis value lent against
par_amountintegerOptionalprice_microsintegerOptionalPer 100 of par, scaled by 1,000,000
principal_amountintegerOptionalreferencestringRequiredlendable_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-timeRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503