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

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

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