The ACH Transfer object

An ACH credit or debit the bank originates: screened before it leaves, batched into a NACHA file at the window, settled or returned by the network.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

change_idstringOptional

The notification of change applied at origination

counterpartyobjectRequired

4 child attributes

account_numberstringRequired

account_typestringRequired

namestringRequired

routing_numberstringRequired

created_atstring · date-timeRequired

currency_codestringRequired

descriptionstringRequired

directionstringRequired

effective_datestring · dateRequired

A business date, YYYY-MM-DD

file_idstringRequired

Example achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm

hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

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 acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

originator_idstringOptional

The Originator whose exposure limit the entry counts against

prenotebooleanOptional

prenote_statusstringOptional

Pending, verified, returned or changed

return_codestringRequired

return_reasonstringRequired

reversal_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

same_daybooleanRequired

Settles in a Same Day ACH window on the effective date

screening_resultstringOptional

sec_codestringRequired

statusstringRequired

trace_numberstringRequired