Approve (sending the transfer to the operator and booking a sale's settlement from its acknowledgment) or reject a proposed transfer (a securities checker other than its maker)
/ledger/fedwire-securities/deliveries/{id}/reviewThe guard admits staff holding ledger:securities:write and ledger:securities:approve; the store requires a step-up within five minutes and a checker other than the maker, refused 422 ledger.maker_checker_required (the database refuses it too). The same decision by the same checker replays; a different one is 409 conflict. The operator is the Fedwire Securities Service simulator: nothing it answers is a Reserve Bank message. Approval sends the proposed transfer: the acknowledgment settles it (a sale's settlement is booked from it, a reversal marks its advice reversed) and a rejection refuses it with the operator's reason. When the operator does not answer the call is 424 dependency_failed, the delivery stays sending, and the same review resends the same message.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
approvebooleanRequiredreasonstringRequiredReturns
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