HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Perform an INTERNATIONAL WIRE outbound transaction. This new version of the endpoint optionally supports Foreign Exchange and non-USD currencies.

Body Params
string
length between 1 and 255

Transaction Internal Note

string
required
int32
required
≥ 0
string
required
length between 1 and 255

The first 10 character of the description will be used as Company Entry Description in the Nacha file. (For ACH endpoints). Originator to receiver message (For wire endpoints).

string
length between 1 and 255

External reference ID

string
required
length between 3 and 3

Currency which the beneficiary of the Wire is to receive. Must be an ISO 4217 currency code.

number

Amount in the credit currency. Only one of creditAmount or debitAmount is supported.

string
required
length between 3 and 3

Currency of the local account used for the wire. Currently must always be USD.

number

Amount in the debit currency. Only one of creditAmount or debitAmount is supported.

string

This represents an FX quote that has already been obtained for the specified currency. If this is not given, a new quote will automatically be obtained.

Headers
string

For each new Transaction Request, the optional IdempotencyKey should be a unique identifier (UUID). If the same IdempotencyKey is used a second time for the same API, the application will not process a new transaction, but return the response of previous request. IdempotencyKey records have TTL of 24 hours.

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*