Create an international wire transfer

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

X-Idempotency-Key

string

required

Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns 409 and never replays a response, unlike API v1, which replays the original response for a matching key.

Required string length: 1 - 255

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Body

application/json

Send USD or a supported foreign currency to an international destination.

amount

PositiveMoney · object

required

Exact amount the beneficiary receives. A non-USD amount requires a matching internationalWire.fxQuoteId.

Hide child attributes

amount.amount

integer

required

Amount in the currency's minor units.

Required range: x >= 1

Example:

10000

amount.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

Example:

"GBP"

fromAccount

string

required

Source virtual-account id with the subaccount_ prefix.

Example:

"subaccount_source123"

destinationId

string

required

Saved international-wire destination.

Example:

"le_contact_destination_intl123"

internationalWire

object

required

Hide child attributes

internationalWire.purposeCode

string

required

Purpose code required by the destination rail.

Minimum string length: 1

Example:

"GDDS"

internationalWire.fxQuoteId

string

Unexpired FX quote matching amount. Required when the currency is not USD and forbidden when it is USD.

Example:

"fx_rate_quote_123"

internationalWire.remittanceInfo

string

Optional remittance information shown to the beneficiary.

internationalWire.intermediaryBankBic

string

Optional BIC for an intermediary bank.

description

string

Human-readable private transfer memo.

Example:

"International invoice 1042"

Response

The created international wire transfer.

A domestic-currency or foreign-currency international wire.

string

required

Transfer id with the transfer_intent_ prefix.

Example:

"transfer_intent_2rj4l7hmrrrcv"

accountId

string

required

Account containing the source balance.

Example:

"sa_group_primary123"

amount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amount.amount

integer

required

Amount in the currency's minor units.

amount.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

transactionIds

string[]

required

Transaction ids produced by this transfer.

Transaction id with the agg_tx_ prefix.

createdAt

string<date-time>

required

Time the transfer was created.

type

enum<string>

required

Available options:

international_wire

status

enum<string>

required

Lifecycle state of a domestic or international wire transfer.

Available options:

pending,

pending_approval,

in_review,

scheduled,

canceled,

failed,

settled,

returned

internationalWire

object

required

Hide child attributes

internationalWire.fxQuoteId

string

internationalWire.purposeCode

string

internationalWire.remittanceInfo

string

internationalWire.intermediaryBankBic

string

internationalWire.uetr

string

internationalWire.returnReason

string

fromAccount

string

Source virtual-account id, when the transfer is scoped to one.

Example:

"subaccount_operations123"

description

string

Human-readable private transfer memo.

Example:

"Invoice 1042"

statementDescriptor

string

Statement or network descriptor supplied when the transfer was created.

Example:

"VENDOR PAYMENT"

submittedAt

string<date-time>

Time the transfer was submitted for processing.

settledAt

string<date-time>

Time the transfer settled.

failedAt

string<date-time>

Time the transfer failed.

canceledAt

string<date-time>

Time the transfer was canceled.

contactId

string

Contact receiving the transfer.

Example:

"le_c_vendor123"

destinationId

string

Saved destination used for the transfer.

Example:

"le_contact_destination_intl123"

Accounts

Virtual accounts

Contacts

Transfers

Transactions

Create an international wire transfer

Authorizations

Headers

Body

Response