Send the approved transfer request to the delivering custodian and retain its validation or exception
/accounts/{id}/retirement-inbound-transfers/{transfer}/custodian-requestsFresh 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
idstringRequiredtransferstringRequiredHeaders
Idempotency-KeystringRequiredSend 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_refstringRequiredevidence_sha256stringRequiredreasonstringRequiredReturns
200 OK
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
confirmation_sha256stringRequiredcustodian_confirmationobjectRequiredConfirmation 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_minorintegerOptionaldelivering_referencestringOptionaldelivering_routing_numberstringOptionaldelivery_methodstringOptionaldistribution_datestring · dateRequiredA business date, YYYY-MM-DD
exception_codestringOptionalexception_reasonstringOptionalrequest_idstringRequiredExample req_2tVh8nqLxq4GbDe0K1F6S9zRcWm
settlement_datestring · dateRequiredA business date, YYYY-MM-DD
simulatedbooleanRequiredstatusstringRequiredAccepted or rejected
custodian_requestobjectRequiredRequest is what the receiving custodian sends.
13 child attributes
account_holder_namestringRequiredamount_minorintegerOptionalauthorization_sha256stringRequireddecedent_namestringOptionaldelivering_account_referencestringRequiredmatch_referencestringRequiredplan_typestringRequiredreceiving_account_numberstringRequiredreceiving_account_titlestringRequiredreceiving_institutionstringRequiredreceiving_routing_numberstringRequiredrequest_idstringRequiredExample req_2tVh8nqLxq4GbDe0K1F6S9zRcWm
transfer_scopestringRequiredFull or partial
idstringRequiredrecorded_atstring · date-timeRequiredrequested_bystringRequiredtransfer_idstringRequiredExample acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503