Simulate an incoming bank transfer (pacs.009) onto the transit account
POST
/simulate/transfers/wire/bank-receiveHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
amountintegerRequiredinfostringOptionalreferencestringRequiredsender_namestringRequiredsender_routing_numberstringRequiredReturns
200 OK
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcounterpartyobjectRequired9 child attributes
abastringRequiredaccount_numberstringRequiredaddressarray of stringsOptionalFree-format lines, up to three of 35 characters
bank_namestringRequiredcitystringOptionalcountrystringOptionalnamestringRequiredpostal_codestringOptionalstatestringOptionaldirectionstringRequiredgl_codestringOptionalidstringRequiredExample wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm
imadstringRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredCustomer, bank or return
local_instrumentstringOptionalmemostringOptionalomadstringRequiredoperatorstringOptionaloriginal_wire_idstringOptionalExample wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm
queued_untilstring · date-time or nullOptionalWhile queued: the next opening for customer transfers
reasonstringRequiredreturn_reasonstringOptionalreturn_reason_codestringOptionalscreening_resultstringRequiredstatusstringRequireduetrstringOptionalvalue_datestring · date or nullOptionalThe Fedwire cycle date it settles on
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503