Corgi BankDocumentation
OpenAPI

The Fedwire Securities Connection object

FedSecuritiesAdvice is an operator advice the ledger retained, how it was matched and what came of it.

Attributes

business_datestring · dateRequired

A business date, YYYY-MM-DD

content_sha256stringRequired
dispositionstringRequired

Order_settlement, collateral_return, collateral_pledge or unmatched

idintegerRequired
lender_idintegerOptional
messageobjectRequired

Message 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 · 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

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, ...

sender_referencestringRequired

Unique for the Sender; a resend returns the original answer

type_codestringRequired
versionstringRequired
versionstringRequired
operator_referencestringRequired
order_idstringOptional
outcomestringRequired

Settled, recorded, exception or reversed

reasonstringOptional
received_bystringRequired
received_viastringRequired

Delivery or sync

recorded_atstring · date-timeRequired
updated_atstring · date-timeRequired

to move to open esc to close