Skip to main content
POST
/
virtual-account
Create a virtual account
curl --request POST \
  --url https://api.slash.com/virtual-account \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "accountId": "<string>",
  "name": "<string>",
  "commissionDetails": {
    "amount": {
      "amountCents": 123
    },
    "startDate": "2023-11-07T05:31:56Z"
  }
}
'
{
  "virtualAccount": {
    "id": "<string>",
    "name": "<string>",
    "accountId": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "closedAt": "<string>"
  },
  "commissionRule": {
    "id": "<string>",
    "virtualAccountId": "<string>",
    "commissionDetails": {
      "amount": {
        "amountCents": 123
      },
      "startDate": "2023-11-07T05:31:56Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.slash.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Body

application/json
accountId
string
required

The account ID the virtual account should be created under.

name
string
required

The name of the virtual account

commissionDetails
VirtualAccountCommissionDetails · object

Specifies how much of the virtual account's incoming funds should be diverted to the primary account

Response

OK

virtualAccount
VirtualAccountModel · object
required

The virtual account object

commissionRule
VirtualAccountCommissionRule · object

The virtual account commission rule object