List a pledge's deliveries to and releases through its lender, oldest first
/ledger/collateral/pledges/{id}/lender-submissionsA read needs ledger:read or ledger:post.
Path parameters
idstringRequiredReturns
200 OK
dataarray of objectsRequired18 child attributes
actorstringRequiredchannelstringRequiredLoan_schedule, restricted_account or safekeeping_delivery
created_atstring · date-timeRequiredcusipstringOptionaldecisionobject 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_amountintegerRequiredversionstringRequiredidintegerRequiredlender_idintegerRequiredlot_idstringOptionalpar_amountintegerRequiredpledge_idintegerRequiredpurposestringRequiredreasonstringOptionalreferencestringRequiredstatusstringRequiredSending, transfer_settled, acknowledged or refused
submissionobjectRequiredCollateralSubmission pledges or withdraws loans on the lender's collateral schedule, or gives notice of securities pledged through Fedwire Securities, or asks for their release.
7 child attributes
actionstringRequiredborrowerstringRequiredlenderstringRequiredloansarray of objectsOptional7 child attributes
asset_classstringRequiredcharged_offbooleanRequireddays_past_dueintegerRequiredloan_idstringRequiredExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
maturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
nonaccrualbooleanRequiredoutstanding_principal_amountintegerRequiredreferencestringRequiredsecuritiesarray of objectsOptional3 child attributes
cusipstringRequiredoperator_referencestringOptionalpar_amountintegerRequiredversionstringRequiredtransferobject or nullOptionalTransfer is a transfer message: an entitlement order to debit the Sender's securities account and credit the Receiver's for a par amount of one security, with a payment when it is against payment (6.1.1, 6.1.2).
13 child attributes
against_paymentbooleanRequiredbeneficiary_referencestringOptionalThe Receiver's reference, quoted back on the advice
business_datestring · dateRequiredA business date, YYYY-MM-DD
created_atstring · date-timeRequiredcusipstringRequiredoriginal_operator_referencestringOptionalThe transfer a reversal reverses
par_amountintegerRequiredpayment_amountintegerRequiredreceiverobjectRequiredAccount is one securities account on a Reserve Bank's books: the participant's primary routing number and the account's name. A restricted account names the secured party whose interest the Reserve Bank marks (4.5.2).
4 child attributes
abastringRequirednamestringRequiredrestrictedbooleanRequiredsecured_partystringOptionalDiscount_window, fhlb, public_funds, ...
senderobjectRequiredAccount is one securities account on a Reserve Bank's books: the participant's primary routing number and the account's name. A restricted account names the secured party whose interest the Reserve Bank marks (4.5.2).
4 child attributes
abastringRequirednamestringRequiredrestrictedbooleanRequiredsecured_partystringOptionalDiscount_window, fhlb, public_funds, ...
sender_referencestringRequiredUnique for the Sender; a resend returns the original answer
type_codestringRequiredversionstringRequiredtransfer_answerobject or nullOptionalMessage is the operator's answer to a transfer: an acknowledgment to the Sender, an advice to the Receiver, or a rejection to the Sender. The operator reference is assigned when the service time-stamps the message (6.3.2); the settled time is when the debits and credits became final (9.2.1).
11 child attributes
business_datestring · dateRequiredA business date, YYYY-MM-DD
key_idstringRequiredkindstringRequiredoperator_referencestringRequiredprocessed_atstring · date-timeRequiredreasonstringOptionalreason_codestringOptionalsignaturestringRequiredstatusstringRequiredSettled or rejected
transferobjectRequiredTransfer is a transfer message: an entitlement order to debit the Sender's securities account and credit the Receiver's for a par amount of one security, with a payment when it is against payment (6.1.1, 6.1.2).
13 child attributes
against_paymentbooleanRequiredbeneficiary_referencestringOptionalThe Receiver's reference, quoted back on the advice
business_datestring · dateRequiredA business date, YYYY-MM-DD
created_atstring · date-timeRequiredcusipstringRequiredoriginal_operator_referencestringOptionalThe transfer a reversal reverses
par_amountintegerRequiredpayment_amountintegerRequiredreceiverobjectRequiredAccount is one securities account on a Reserve Bank's books: the participant's primary routing number and the account's name. A restricted account names the secured party whose interest the Reserve Bank marks (4.5.2).
senderobjectRequiredAccount is one securities account on a Reserve Bank's books: the participant's primary routing number and the account's name. A restricted account names the secured party whose interest the Reserve Bank marks (4.5.2).
sender_referencestringRequiredUnique for the Sender; a resend returns the original answer
type_codestringRequiredversionstringRequiredversionstringRequiredupdated_atstring · date-timeRequiredhas_morebooleanRequiredWhether another page follows
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503