List book transfers

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

Query Parameters

cursor

string

Pass the opaque value returned in metadata.nextCursor without changing the other query parameters.

status

enum<string>

Return book transfers in one lifecycle state. Lifecycle state of a book transfer between Slash balances.

Available options:

pending,

scheduled,

in_review,

canceled,

failed,

settled

accountId

string

Return transfers for one accessible Account.

fromAccount

string

Return transfers from one accessible virtual account.

from

string<date-time>

Inclusive RFC 3339 lower bound on transfer date: the date of the transfer's source transaction, which is also the list order.

string<date-time>

Inclusive RFC 3339 upper bound on transfer date: the date of the transfer's source transaction, which is also the list order.

Response

A page of book transfers.

items

TransferBook · object[]

required

Hide child attributes

items.id

string

required

Transfer id with the transfer_intent_ prefix.

Example:

"transfer_intent_2rj4l7hmrrrcv"

items.accountId

string

required

Account containing the source balance.

Example:

"sa_group_primary123"

items.amount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

items.amount.amount

integer

required

Amount in the currency's minor units.

items.amount.currency

string

required

Uppercase ISO 4217 currency code.

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

items.transactionIds

string[]

required

Transaction ids produced by this transfer.

Transaction id with the agg_tx_ prefix.

items.createdAt

string<date-time>

required

Time the transfer was created.

items.type

enum<string>

required

Available options:

book

items.status

enum<string>

required

Lifecycle state of a book transfer between Slash balances.

Available options:

pending,

scheduled,

in_review,

canceled,

failed,

settled

items.fromAccount

string

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

Example:

"subaccount_operations123"

items.description

string

Human-readable private transfer memo.

Example:

"Invoice 1042"

items.statementDescriptor

string

Statement or network descriptor supplied when the transfer was created.

Example:

"VENDOR PAYMENT"

items.submittedAt

string<date-time>

Time the transfer was submitted for processing.

items.settledAt

string<date-time>

Time the transfer settled.

items.failedAt

string<date-time>

Time the transfer failed.

items.canceledAt

string<date-time>

Time the transfer was canceled.

items.toAccount

string

Destination virtual-account id.

Example:

"subaccount_payroll123"

metadata

PaginationMetadata · object

required

Hide child attributes

metadata.count

integer

required

Number of items in this page.

Required range: x >= 0

metadata.nextCursor

string

Opaque cursor for the next page. Omitted on the final page.

Accounts

Virtual accounts

Contacts

Transfers

Transactions

List book transfers

Authorizations

Headers

Query Parameters

Response