Retrieve a wire transfer

{ "id": "transfer_intent_2rj4l7hmrrrcv", "accountId": "sa_group_primary123", "amount": { "amount": 123, "currency": "<string>" }, "transactionIds": [ "agg_tx_2rj4l7hmrrrcv" ], "createdAt": "2023-11-07T05:31:56Z", "type": "wire", "status": "pending", "wire": { "imad": "<string>", "omad": "<string>", "returnReason": "<string>" }, "fromAccount": "subaccount_operations123", "description": "Invoice 1042", "statementDescriptor": "VENDOR PAYMENT", "submittedAt": "2023-11-07T05:31:56Z", "settledAt": "2023-11-07T05:31:56Z", "failedAt": "2023-11-07T05:31:56Z", "canceledAt": "2023-11-07T05:31:56Z", "contactId": "le_c_vendor123", "destinationId": "le_contact_destination_bank123" }

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-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]+$

Path Parameters

transferId

string

required

Transfer id with the transfer_intent_ prefix.

Response

The wire transfer.

A domestic wire transfer.

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:

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

wire

object

required

Hide child attributes

wire.imad

string

wire.omad

string

wire.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_bank123"

Accounts

Virtual accounts

Contacts

Transfers

Transactions

Retrieve a wire transfer

Authorizations

Headers

Path Parameters

Response