Record a lender's signed collateral statement and open a break for every difference from the register (treasury staff)
/ledger/collateral/statementsThe ledger's guard admits ledger:treasury:write on this route and refuses ledger:post; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The statement is signed with ed25519 over ledger.collateral.statement.v1, a NUL byte and the statement without its signature, by one of the lender's retained keys; as_of cannot be after the business date. A break opens for every difference from the register; the same key or signed content replays.
Headers
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
as_ofstring · dateRequiredA business date, YYYY-MM-DD
assetsarray of objectsRequired2 child attributes
lendable_amountintegerRequiredreferencestringRequiredcapacity_amountintegerRequiredkey_idstringRequiredlendable_amountintegerRequiredlender_idintegerRequiredobserved_atstring · date-timeRequiredsignaturestringRequiredBase64 ed25519 over the version, a NUL byte and the statement without its signature
sourceobject or nullOptionalThe lender's own signed statement, on a statement imported through its connection (version ledger.collateral.statement.lender-report.v1)
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_amountintegerRequiredversionstringRequiredversionstringRequiredLedger.collateral.statement.v1
Returns
200 OK
as_ofstring · dateRequiredA business date, YYYY-MM-DD
breaksarray of objectsRequired12 child attributes
idintegerRequiredkindstringRequiredMissing_at_lender, missing_in_register, value_difference, capacity_difference or pledged_asset_ended
lender_amountintegerRequiredlender_idintegerRequiredopened_atstring · date-timeRequiredpledge_idintegerOptionalThe pledge a pledged_asset_ended break names
referencestringOptionalregister_amountintegerRequiredresolutionstringOptionalresolved_atstring · date-time or nullOptionalresolved_bystringOptionalstatement_idintegerRequiredZero for a pledged_asset_ended break
content_sha256stringRequiredidintegerRequiredlender_idintegerRequiredrecorded_atstring · date-timeRequiredrecorded_bystringRequiredreviewobject or nullOptionalReviewRecord is a retained review.
5 child attributes
approvebooleanRequiredcheckerstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredrecorded_atstring · date-timeRequiredstatementobjectRequiredCollateralStatement is a lender's signed collateral statement.
10 child attributes
as_ofstring · dateRequiredA business date, YYYY-MM-DD
assetsarray of objectsRequired2 child attributes
lendable_amountintegerRequiredreferencestringRequiredcapacity_amountintegerRequiredkey_idstringRequiredlendable_amountintegerRequiredlender_idintegerRequiredobserved_atstring · date-timeRequiredsignaturestringRequiredBase64 ed25519 over the version, a NUL byte and the statement without its signature
sourceobject or nullOptionalThe lender's own signed statement, on a statement imported through its connection (version ledger.collateral.statement.lender-report.v1)
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_amountintegerRequiredversionstringRequiredversionstringRequiredLedger.collateral.statement.v1
statusstringRequiredPending_review, approved or rejected
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503