Create an ACH transfer

POST/transfers/ach

Originate an ACH credit or debit

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)

counterpartyobjectRequired

4 child attributes

account_numberstringRequired

account_typestringRequired

namestringRequired

routing_numberstringRequired

currency_codestringRequired

ISO 4217 code

descriptionstringRequired

directionstringRequired

effective_datestring · date or nullOptional

A business date, YYYY-MM-DD

iatobject or nullOptional

The international addenda; sec_code IAT

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

prenotebooleanOptional

A zero-dollar prenotification that verifies the counterparty's account; live entries may follow three banking days after it settles

same_daybooleanOptional

Settle today in the next Same Day ACH window (limit $1,000,000.00 per entry, no IAT)

sec_codestringRequired

Returns

201 Created

The ACH Transfer object.

Errors

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

400401403404409412413422424429500503