Simulate an incoming ACH credit or debit

POST/simulate/transfers/ach/receive

Headers

Idempotency-KeystringOptional

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

account_numberstringRequired

account_typestringOptional

The transaction code's account type: checking (default) or savings

amountintegerRequired

currency_codestringRequired

descriptionstringRequired

directionstringRequired

Credit (money arrives) or debit (a pull against the account)

individual_idstringRequired

ofac_indicatorstringOptional

On IAT: the Gateway Operator's indicator, 0 or 1

originator_countrystringOptional

On IAT: the foreign originator's country, CA by default

originator_namestringRequired

originator_routing_numberstringRequired

prenotebooleanOptional

A zero-dollar prenotification

receiver_namestringOptional

sec_codestringOptional

PPD (default), CCD or IAT

Returns

200 OK

fileobjectRequired

8 child attributes

directionstringRequired

effective_datestring · dateRequired

A business date, YYYY-MM-DD

entry_countintegerRequired

idstringRequired

rail_refstringRequired

statusstringRequired

total_credit_amountintegerRequired

total_debit_amountintegerRequired

receiptsarray of objectsRequired

25 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

account_numberstringRequired

amountintegerRequired

company_idstringOptional

effective_datestring · date or nullOptional

A business date, YYYY-MM-DD

file_idstringRequired

Example achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm

hold_reasonstringOptional

iatobject or nullOptional

IATDetails 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 objectsOptional

4 child attributes

branch_countrystringRequired

idstringRequired

id_qualifierstringRequired

01 national clearing system, 02 BIC, 03 IBAN

namestringRequired

destination_countrystringRequired

destination_currencystringRequired

foreign_amountintegerOptional

foreign_exchange_indicatorstringOptional

FF (default), FV, VF

foreign_exchange_referencestringOptional

foreign_tracestringOptional

ofac_indicatorstringOptional

The Gateway Operator's: 0 no match, 1 a potential match

originating_currencystringOptional

USD by default

originating_dfiobjectRequired

IATDFI is a bank on an international entry.

4 child attributes

branch_countrystringRequired

idstringRequired

id_qualifierstringRequired

01 national clearing system, 02 BIC, 03 IBAN

namestringRequired

originatorobjectRequired

IATParty is the originator or the receiver of an international entry.

7 child attributes

citystringRequired

countrystringRequired

ISO 3166-1 alpha-2

idstringOptional

namestringRequired

postal_codestringOptional

regionstringOptional

streetstringRequired

receiverobjectRequired

IATParty is the originator or the receiver of an international entry.

7 child attributes

citystringRequired

countrystringRequired

ISO 3166-1 alpha-2

idstringOptional

namestringRequired

postal_codestringOptional

regionstringOptional

streetstringRequired

receiving_dfiobjectRequired

IATDFI is a bank on an international entry.

4 child attributes

branch_countrystringRequired

idstringRequired

id_qualifierstringRequired

01 national clearing system, 02 BIC, 03 IBAN

namestringRequired

remittancearray of stringsOptional

secondary_ofac_indicatorstringOptional

transaction_type_codestringRequired

ANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX, TEL, WEB

idstringRequired

Example achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm

individual_idstringOptional

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

namestringOptional

odfistringOptional

originator_namestringOptional

outcomestringRequired

Posted, returned, accepted (a prenotification), held (an international entry under review), blocked

return_codestringRequired

return_reasonstringRequired

reversal_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reviewed_atstring · date-time or nullOptional

reviewed_bystringOptional

screening_idsarray of stringsOptional

sec_codestringOptional

trace_numberstringRequired

transaction_codestringRequired

replayedbooleanRequired

return_fileobject or nullOptional

8 child attributes

directionstringRequired

effective_datestring · dateRequired

A business date, YYYY-MM-DD

entry_countintegerRequired

idstringRequired

rail_refstringRequired

statusstringRequired

total_credit_amountintegerRequired

total_debit_amountintegerRequired

Errors

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

400401403404409412413422424429500503