Propose a transfer the bank sends: a sold lot delivered against payment to the buyer's securities account, or an exception advice reversed to its sender, pending a securities checker (bank securities staff)
/ledger/fedwire-securities/deliveriesThe ledger's guard admits verified bank securities staff holding ledger:securities:write; the store requires a step-up within five minutes (never a service or an API key). order_id names a sale of a Fedwire Securities program whose trade is recognised and whose delivery is not settled, delivered against its net cash to receiver_aba/receiver_account; advice_id names an exception advice reversed (type code 2002) the same business day. One live delivery per order or advice, else 409 conflict. Pending until a securities checker approves.
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
advice_idintegerOptionalorder_idstringOptionalreasonstringRequiredreceiver_abastringOptionalreceiver_accountstringOptionalReturns
200 OK
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_codestringRequiredversionstringRequiredversionstringRequiredidintegerRequiredmakerstringRequiredpurposestringRequiredSale_delivery or advice_reversal
reasonstringOptionalrecorded_atstring · date-timeRequiredrequestobjectRequiredFedSecuritiesDeliveryRequest proposes a transfer the bank sends: exactly one of order_id (a sold lot delivered against payment to receiver_aba/receiver_account) or advice_id (an exception advice reversed to its sender).
5 child attributes
advice_idintegerOptionalorder_idstringOptionalreasonstringRequiredreceiver_abastringOptionalreceiver_accountstringOptionalreviewobject or nullOptionalReviewRecord is a retained review.
5 child attributes
approvebooleanRequiredcheckerstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredrecorded_atstring · date-timeRequiredstatusstringRequiredPending_review, rejected, sending, settled or refused
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_codestringRequiredversionstringRequiredupdated_atstring · date-timeRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503