Create a book 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

Move USD between virtual accounts in the same Account.

amount

UsdMoney · object

required

A positive USD amount expressed in cents.

Hide child attributes

amount.amount

integer

required

Amount in cents. For example, 1250 represents USD 12.50.

Required range: x >= 1

Example:

1250

amount.currency

enum<string>

required

Available options:

USD

fromAccount

string

required

Source virtual-account id with the subaccount_ prefix.

Example:

"subaccount_source123"

toAccount

string

required

Destination virtual-account id in the same Account.

Example:

"subaccount_destination123"

description

string

Human-readable private transfer memo.

Example:

"Move funds to payroll"

Response

The created book transfer.

A transfer between Slash balances in the same Account.

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:

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"

Accounts

Virtual accounts

Contacts

Transfers

Transactions

Create a book transfer

Authorizations

Headers

Body

Response