A lender's latest signed statement, the register's position and the breaks still open
/ledger/collateral/lenders/{id}/reconciliationA read needs ledger:read or ledger:post.
Path parameters
idstringRequiredReturns
200 OK
capacityobjectRequiredLenderCapacity is a lender's position: lendable value of acknowledged eligible pledges, advances outstanding and what may still be drawn.
14 child attributes
as_ofstring · dateRequiredA business date, YYYY-MM-DD
capacity_amountintegerRequiredgl_codestringRequiredhorizonstring · dateRequiredA business date, YYYY-MM-DD
ineligible_pledgesintegerRequiredlegal_namestringRequiredlendable_amountintegerRequiredlender_idintegerRequiredlender_kindstringRequiredoutstanding_amountintegerRequiredpledged_value_amountintegerRequiredpledgesarray of objectsRequired13 child attributes
assetobjectRequiredCollateralAsset is one bank-owned asset the register values.
12 child attributes
asset_classstringRequiredidintegerRequiredkindstringRequiredSecurities_lot or loan
loanobject or nullOptionalLoanCollateralFacts are the lending service's facts about a loan as of a date.
maturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
maturity_unresolvedbooleanRequiredreferencestringRequiredupdated_atstring · date-timeRequiredvaluation_as_ofstring · dateRequiredA business date, YYYY-MM-DD
valuation_basisstringRequiredvaluation_sha256stringOptionalvalue_amountintegerRequiredcreated_atstring · date-timeRequiredeligiblebooleanRequiredhaircut_bpsintegerRequiredidintegerRequiredineligibilityarray of stringsRequiredlendable_amountintegerRequiredlender_idintegerRequiredmakerstringRequiredpledge_referencestringOptionalstatestringRequiredReserved, pledged, releasing or released
updated_atstring · date-timeRequiredvalue_amountintegerRequiredschedule_idintegerOptionalshortfall_amountintegerRequiredlender_idintegerRequiredopen_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
statementobject or nullOptionalCollateralStatementRecord is a retained statement with the breaks it opened and the independent review of its reconciliation.
10 child attributes
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.
borrowerstringRequiredThe bank as the lender names it
collateralobject or nullOptionalCollateralDecision answers a collateral submission item by item.
issued_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.
scheduleobject or nullOptionalCollateralSchedule is the lender's collateral schedule in force from a date.
signaturestringRequiredstatementobject 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.
versionstringRequiredversionstringRequiredLedger.collateral.statement.v1
statusstringRequiredPending_review, approved or rejected
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503