SLslashfi

Create a virtual account

Changed on

Create a new balance-bearing virtual account inside an accessible non-Global USD bank Account. Global USD Accounts are not eligible. The parent Account must be provided because a legal entity can have more than one. The virtual account starts with a zero balance. Use its id as fromAccount or toAccount in a per-rail transfer create endpoint.

post/v2/virtual-accounts

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/virtual-accounts
  • Auth
    API key in header X-API-Key

Headers

X-Idempotency-Keystring 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.

Request body

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

namestring required

Display name for the virtual account.

Example request

{
  "accountId": "sa_group_primary123",
  "name": "Payroll",
  "commission": {
    "amount": {
      "amount": 1250
    }
  }
}

Response

The created virtual account.

idstring required

Virtual account id with the subaccount_ prefix.

namestring required
accountIdstring required

Parent Account id with the sa_group_ prefix.

accountType'primary' | 'default' required
status'open' | 'closed' required

Example response

{
  "commission": {
    "amount": {
      "amount": 1250
    }
  }
}

Changes