The International Transfer object
IATTransfer is an international entry the bank originated: the ACH entry underneath it, with the international parties, their banks and the currencies at the top level.
Attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcorrespondentsarray of objectsOptional4 child attributes
branch_countrystringRequiredidstringRequiredid_qualifierstringRequired01 national clearing system, 02 BIC, 03 IBAN
namestringRequiredcounterpartyobjectRequired4 child attributes
account_numberstringRequiredaccount_typestringRequirednamestringRequiredrouting_numberstringRequiredcreated_atstring · date-timeRequiredcurrency_codestringRequiredcustomer_idstringOptionalExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
descriptionstringRequireddestination_countrystringRequireddestination_currencystringRequireddirectionstringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
file_idstringOptionalExample achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm
foreign_amountintegerOptionalforeign_exchange_indicatorstringOptionalFF (default), FV, VF
foreign_exchange_referencestringOptionalforeign_tracestringOptionalhold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
ofac_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_codestringOptionalregionstringOptionalstreetstringRequiredoriginator_idstringOptionalreceiverobjectRequiredIATParty 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 stringsOptionalreturn_codestringOptionalreturn_reasonstringOptionalreversal_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
screening_resultstringOptionalsecondary_ofac_indicatorstringOptionalstatusstringRequiredtrace_numberstringOptionaltransaction_type_codestringRequiredANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX, TEL, WEB
transfer_idstringRequiredThe ACH transfer this resource is a view of
Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm
updated_atstring · date-timeRequired