Skip to main content
GET
Retrieve a book transfer
Read Sending book transfers for setup, examples, and reconciliation guidance.

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

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 book transfer.

A transfer between Slash balances in the same Account.

id
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.

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:
book
status
enum<string>
required

Lifecycle state of a book transfer between Slash balances.

Available options:
pending,
scheduled,
in_review,
canceled,
failed,
settled
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.

toAccount
string

Destination virtual-account id.

Example:

"subaccount_payroll123"