Corgi BankDocumentation
OpenAPI

List proposed and sent transfers, those waiting for review or the operator first

GET/ledger/fedwire-securities/deliveries

A read needs ledger:securities:read; ledger:read alone is refused 403 forbidden.

Returns

200 OK

dataarray of objectsRequired
11 child attributes
answerobject or nullOptional

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

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

sender_referencestringRequired

Unique for the Sender; a resend returns the original answer

type_codestringRequired
versionstringRequired
versionstringRequired
idintegerRequired
makerstringRequired
purposestringRequired

Sale_delivery or advice_reversal

reasonstringOptional
recorded_atstring · date-timeRequired
requestobjectRequired

FedSecuritiesDeliveryRequest 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_idintegerOptional
order_idstringOptional
reasonstringRequired
receiver_abastringOptional
receiver_accountstringOptional
reviewobject or nullOptional

ReviewRecord is a retained review.

5 child attributes
approvebooleanRequired
checkerstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reasonstringRequired
recorded_atstring · date-timeRequired
statusstringRequired

Pending_review, rejected, sending, settled or refused

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
updated_atstring · date-timeRequired
has_morebooleanRequired

Whether another page follows

Errors

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

400401403404409412413422424429500503

to move to open esc to close