Corgi BankDocumentation
OpenAPI

Send the approved transfer request to the delivering custodian and retain its validation or exception

POST/accounts/{id}/retirement-inbound-transfers/{transfer}/custodian-requests

Fresh retirement writer. Sends the independently approved instruction, re-validated against the current account, holder and classification, to the delivering custodian and retains its validation or exception. The request id is the instruction id, so a retry after a lost answer receives the same confirmation, and a retained confirmation is returned rather than requested again. Locally the adapter is the delivering-custodian simulator, whose answers are marked simulated and are relied on only in the local environment; real transfers are bilateral or run through DTCC's ACATS for NSCC participants, whose formats are proprietary, and no certified integration exists. An accepted answer above the reviewed maximum or from another sending routing number refuses.

Path parameters

idstringRequired
transferstringRequired

Headers

Idempotency-KeystringRequired

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

evidence_refstringRequired
evidence_sha256stringRequired
reasonstringRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

confirmation_sha256stringRequired
custodian_confirmationobjectRequired

Confirmation is the delivering custodian's validation or exception. Simulated is true for every confirmation the simulator produces and must be false from a certified integration.

11 child attributes
amount_minorintegerOptional
delivering_referencestringOptional
delivering_routing_numberstringOptional
delivery_methodstringOptional
distribution_datestring · dateRequired

A business date, YYYY-MM-DD

exception_codestringOptional
exception_reasonstringOptional
request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

settlement_datestring · dateRequired

A business date, YYYY-MM-DD

simulatedbooleanRequired
statusstringRequired

Accepted or rejected

custodian_requestobjectRequired

Request is what the receiving custodian sends.

13 child attributes
account_holder_namestringRequired
amount_minorintegerOptional
authorization_sha256stringRequired
decedent_namestringOptional
delivering_account_referencestringRequired
match_referencestringRequired
plan_typestringRequired
receiving_account_numberstringRequired
receiving_account_titlestringRequired
receiving_institutionstringRequired
receiving_routing_numberstringRequired
request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

transfer_scopestringRequired

Full or partial

idstringRequired
recorded_atstring · date-timeRequired
requested_bystringRequired
transfer_idstringRequired

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

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

400401403404409412413422424429500503

to move to open esc to close