Deliver a reserved pledge to its lender (a loan listed on the lender's schedule; a securities lot moved by a Fedwire Securities transfer to the lender's account first) or ask the lender to release an acknowledged one; the lender's signed decision moves the pledge (treasury staff)
/ledger/collateral/pledges/{id}/lender-submissionsThe 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. purpose pledge takes a reserved pledge (a loan is listed on the lender's schedule; a Treasury lot is first moved free of payment through the Fedwire Securities simulator to the lender's securities account); release takes a pledged one and is refused 409 conflict when it would leave the lender's advances uncovered. The lender's signed acceptance moves the pledge to pledged, its release to released; a refusal is retained with its reason. One submission in flight per pledge, else 409. When the operator or lender does not answer the call 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
purposestringRequiredPledge or release
Returns
200 OK
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 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_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).
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_codestringRequiredversionstringRequiredversionstringRequiredupdated_atstring · date-timeRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503