Read a retained lender statement, its breaks and its review

GET/ledger/collateral/statements/{id}

A read needs ledger:read or ledger:post.

Path parameters

idstringRequired

Returns

200 OK

as_ofstring · dateRequired

A business date, YYYY-MM-DD

breaksarray of objectsRequired

12 child attributes

idintegerRequired

kindstringRequired

Missing_at_lender, missing_in_register, value_difference, capacity_difference or pledged_asset_ended

lender_amountintegerRequired

lender_idintegerRequired

opened_atstring · date-timeRequired

pledge_idintegerOptional

The pledge a pledged_asset_ended break names

referencestringOptional

register_amountintegerRequired

resolutionstringOptional

resolved_atstring · date-time or nullOptional

resolved_bystringOptional

statement_idintegerRequired

Zero for a pledged_asset_ended break

content_sha256stringRequired

idintegerRequired

lender_idintegerRequired

recorded_atstring · date-timeRequired

recorded_bystringRequired

reviewobject or nullOptional

ReviewRecord is a retained review.

5 child attributes

approvebooleanRequired

checkerstringRequired

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reasonstringRequired

recorded_atstring · date-timeRequired

statementobjectRequired

CollateralStatement is a lender's signed collateral statement.

10 child attributes

as_ofstring · dateRequired

A business date, YYYY-MM-DD

assetsarray of objectsRequired

2 child attributes

lendable_amountintegerRequired

referencestringRequired

capacity_amountintegerRequired

key_idstringRequired

lendable_amountintegerRequired

lender_idintegerRequired

observed_atstring · date-timeRequired

signaturestringRequired

Base64 ed25519 over the version, a NUL byte and the statement without its signature

sourceobject or nullOptional

The lender's own signed statement, on a statement imported through its connection (version ledger.collateral.statement.lender-report.v1)

13 child attributes

advanceobject or nullOptional

AdvanceConfirmation 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_numberstringOptional

available_amountintegerRequired

The collateral value available before the advance

day_count_basisstringRequired

Actual/365 or actual/360

maturity_datestring · dateRequired

A business date, YYYY-MM-DD

principal_amountintegerRequired

programstringRequired

rate_bpsintegerRequired

reasonstringOptional

referencestringRequired

statusstringRequired

Made or declined

value_datestring · dateRequired

A business date, YYYY-MM-DD

borrowerstringRequired

The bank as the lender names it

collateralobject or nullOptional

CollateralDecision answers a collateral submission item by item.

3 child attributes

actionstringRequired

itemsarray of objectsRequired

referencestringRequired

issued_atstring · date-timeRequired

issuerstringRequired

The Reserve Bank or the Federal Home Loan Bank

key_idstringRequired

kindstringRequired

lenderstringRequired

repaymentobject or nullOptional

RepaymentConfirmation 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_numberstringRequired

fee_amountintegerRequired

interest_amountintegerRequired

interest_fromstring · dateRequired

A business date, YYYY-MM-DD

interest_throughstring · dateRequired

A business date, YYYY-MM-DD

principal_amountintegerRequired

principal_outstanding_amountintegerRequired

rate_bpsintegerRequired

reasonstringOptional

referencestringRequired

statusstringRequired

Repaid or refused

total_amountintegerRequired

value_datestring · dateRequired

A business date, YYYY-MM-DD

scheduleobject or nullOptional

CollateralSchedule is the lender's collateral schedule in force from a date.

3 child attributes

classesarray of objectsRequired

effective_datestring · dateRequired

A business date, YYYY-MM-DD

sourcestringRequired

signaturestringRequired

statementobject or nullOptional

CollateralStatement 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_amountintegerRequired

advancesarray of objectsRequired

advances_outstanding_amountintegerRequired

as_ofstring · dateRequired

A business date, YYYY-MM-DD

available_amountintegerRequired

itemsarray of objectsRequired

lendable_amountintegerRequired

versionstringRequired

Ledger.collateral.statement.v1

statusstringRequired

Pending_review, approved or rejected

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503