Skip to main content
POST
Create a virtual account

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

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

Create a balance-bearing virtual account inside an accessible, non-Global USD bank Account.

accountId
string
required

Parent non-Global USD bank Account for the new virtual account. This is required even when the legal entity currently has only one Account.

Example:

"sa_group_primary123"

name
string
required

Display name for the virtual account.

Required string length: 1 - 255
Example:

"Payroll"

commission
Flat fee · object

Optionally divert funds from this virtual account to its Account's primary virtual account.

Response

The created virtual account.

A balance-bearing virtual account. Virtual accounts in eligible bank Accounts can source or receive API v2 transfers; Global USD virtual accounts are readable but cannot be used by the API v2 transfer endpoints.

id
string
required

Virtual account id with the subaccount_ prefix.

name
string
required
accountId
string
required

Parent Account id with the sa_group_ prefix.

accountType
enum<string>
required
Available options:
primary,
default
status
enum<string>
required
Available options:
open,
closed
balance
Money · object
required

Current ledger balance. Zero for a newly created virtual account.

commission
Flat fee · object

Funds diverted to the Account's primary virtual account.