Create an international transfer

POST/transfers/iat

Originate an international ACH credit or debit (IAT): the seven mandatory addenda are derived from the parties and their banks, every party is screened, and Same Day settlement is refused

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_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

Minor units of the currency (cents for USD)

correspondentsarray of objectsOptional

4 child attributes

branch_countrystringRequired

idstringRequired

id_qualifierstringRequired

01 national clearing system, 02 BIC, 03 IBAN

namestringRequired

counterpartyobjectRequired

The U.S. Gateway Operator's routing number and the receiver's foreign account or IBAN

4 child attributes

account_numberstringRequired

account_typestringRequired

namestringRequired

routing_numberstringRequired

currency_codestringRequired

ISO 4217 code

descriptionstringRequired

destination_countrystringRequired

destination_currencystringRequired

directionstringRequired

effective_datestring · date or nullOptional

A business date, YYYY-MM-DD

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

same_daybooleanOptional

Refused: Same Day ACH excludes IAT entries

secondary_ofac_indicatorstringOptional

transaction_type_codestringRequired

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

Returns

201 Created

The International Transfer object.

Errors

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

400401403404409412413422424429500503