Take a signed advice from the Fedwire Securities Service (simulator) for one of the bank's securities accounts: a delivery against payment quoting a bank securities order books that order's settlement, a free return from a lender's account is recorded, anything else is retained as an exception (the configured connector only)

POST/ledger/fedwire-securities/advices

The operator is the Fedwire Securities Service simulator: nothing it answers is a Reserve Bank message. Only the configured connector's service identity (svc_fedsecurities locally) holding ledger:fedwire-securities:advice delivers; staff, another service and API keys are refused 403 forbidden. The advice must verify against the operator's configured keys and be a settled advice to one of the bank's accounts, else 422 validation_failed. A delivery against payment quoting a bank securities order books that order's settlement from the message (outcome settled); a free return from a lender's account or the bank's own move into its restricted account is recorded; anything else is an exception with its reason. The same operator reference replays; with other content it is 409 conflict.

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

business_datestring · dateRequired

A business date, YYYY-MM-DD

key_idstringRequired

kindstringRequired

operator_referencestringRequired

processed_atstring · date-timeRequired

reasonstringOptional

reason_codestringOptional

signaturestringRequired

statusstringRequired

Settled or rejected

transferobjectRequired

Transfer 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_paymentbooleanRequired

beneficiary_referencestringOptional

The Receiver's reference, quoted back on the advice

business_datestring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired

cusipstringRequired

original_operator_referencestringOptional

The transfer a reversal reverses

par_amountintegerRequired

payment_amountintegerRequired

receiverobjectRequired

Account 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

abastringRequired

namestringRequired

restrictedbooleanRequired

secured_partystringOptional

Discount_window, fhlb, public_funds, ...

senderobjectRequired

4 child attributes

abastringRequired

namestringRequired

restrictedbooleanRequired

secured_partystringOptional

Discount_window, fhlb, public_funds, ...

sender_referencestringRequired

Unique for the Sender; a resend returns the original answer

type_codestringRequired

versionstringRequired

Returns

200 OK

The Fedwire Securities Connection object.

Errors

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

400401403404409412413422424429500503