Simulate an RDFI returning an originated entry
/simulate/transfers/ach/returnHeaders
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
return_codestringRequiredtrace_numberstringRequiredReturns
200 OK
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredchange_idstringOptionalThe notification of change applied at origination
counterpartyobjectRequired4 child attributes
account_numberstringRequiredaccount_typestringRequirednamestringRequiredrouting_numberstringRequiredcreated_atstring · date-timeRequiredcurrency_codestringRequireddescriptionstringRequireddirectionstringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
file_idstringRequiredExample achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm
hold_idstringRequiredExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
iatobject or nullOptionalIATDetails are the international addenda of an IAT entry. On an entry the bank originates the originator and originating DFI are filled from the customer and the bank when blank; the counterparty routing number is the U.S. Gateway Operator's and the foreign bank is the receiving DFI.
16 child attributes
correspondentsarray of objectsOptional4 child attributes
branch_countrystringRequiredidstringRequiredid_qualifierstringRequired01 national clearing system, 02 BIC, 03 IBAN
namestringRequireddestination_countrystringRequireddestination_currencystringRequiredforeign_amountintegerOptionalforeign_exchange_indicatorstringOptionalFF (default), FV, VF
foreign_exchange_referencestringOptionalforeign_tracestringOptionalofac_indicatorstringOptionalThe Gateway Operator's: 0 no match, 1 a potential match
originating_currencystringOptionalUSD by default
originating_dfiobjectRequiredIATDFI is a bank on an international entry.
4 child attributes
branch_countrystringRequiredidstringRequiredid_qualifierstringRequired01 national clearing system, 02 BIC, 03 IBAN
namestringRequiredoriginatorobjectRequiredIATParty is the originator or the receiver of an international entry.
7 child attributes
citystringRequiredcountrystringRequiredISO 3166-1 alpha-2
idstringOptionalnamestringRequiredpostal_codestringOptionalregionstringOptionalstreetstringRequiredreceiverobjectRequiredIATParty is the originator or the receiver of an international entry.
7 child attributes
citystringRequiredcountrystringRequiredISO 3166-1 alpha-2
idstringOptionalnamestringRequiredpostal_codestringOptionalregionstringOptionalstreetstringRequiredreceiving_dfiobjectRequiredIATDFI is a bank on an international entry.
4 child attributes
branch_countrystringRequiredidstringRequiredid_qualifierstringRequired01 national clearing system, 02 BIC, 03 IBAN
namestringRequiredremittancearray of stringsOptionalsecondary_ofac_indicatorstringOptionaltransaction_type_codestringRequiredANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX, TEL, WEB
idstringRequiredExample acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
originator_idstringOptionalThe Originator whose exposure limit the entry counts against
prenotebooleanOptionalprenote_statusstringOptionalPending, verified, returned or changed
return_codestringRequiredreturn_reasonstringRequiredreversal_journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
same_daybooleanRequiredSettles in a Same Day ACH window on the effective date
screening_resultstringOptionalsec_codestringRequiredstatusstringRequiredtrace_numberstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503