Dashboard
Support
Dashboard

Virtual Account

List virtual accounts

Overview

Getting Started
Changelog

Entities

Legal Entity
Account
Virtual Account
Balance
Card
Card Event Log
Transaction
Spending Constraint
Slash Handle
Card Group
Webhook
Webhook Event
Card group utilization

Legal Entity

GET
List legal entities

Account

GET
List accounts
GET
Get account
GET
List account balances

Virtual Account

GET
List virtual accounts
POST
Create virtual account
GET
Get virtual account
PATCH
Update virtual account

Transaction

GET
List transactions
GET
Get transaction aggregations
GET
Get transaction
GET
Get transaction fee details
PATCH
Add or update a note for a transaction

Slash Pay

GET
List your Slash handles
POST
Send money to a slash handle

Card

GET
List cards
GET
Retrieve card
GET
Get card authorization events
POST
Create card
PATCH
Update card
GET
List all card products

Card Group

GET
List card groups
POST
Create card group
GET
Get card group
PATCH
Update card group
GET
Get card group utilization

Merchant

GET
List merchants
GET
Get merchant
GET
List merchant categories

Webhooks

Overview
GET
List webhooks
POST
Create webhook
PATCH
Update webhook

Virtual Account

List virtual accounts

Retrieve a list of virtual accounts under an account. The virtual accounts are returned in an array, with each item representing a virtual account under that account.

The primary account will also be returned as a virtual account, with an account type of ‘primary’ while actual subaccounts under the primary account will have an account type of ‘default’.

GET

virtual-account

X-API-Key

string

X-API-Key

Required

string

Authentication from public API requests

cursor

string

cursor

string

A cursor string to fetch the next page of results

filter:accountId

string

filter:accountId

string

Pass in an account ID to filter virtual accounts by account ID. This will return all virtual accounts that match the account ID passed in.

filter:includeClosedAccounts

enum<string>

filter:includeClosedAccounts

enum<string>

Include virtual accounts that have been closed in the query results. By default, they will not be returned.

Authorizations

X-API-Key

string

headerrequired

Authentication from public API requests

Query Parameters

cursor

string

A cursor string to fetch the next page of results

filter:accountId

string

Pass in an account ID to filter virtual accounts by account ID. This will return all virtual accounts that match the account ID passed in.

filter:includeClosedAccounts

enum<string>

Include virtual accounts that have been closed in the query results. By default, they will not be returned.

Response

200 - application/json

items

object[]

required

items.virtualAccount

object

required

The virtual account itself

items.virtualAccount.id

string

required

The ID of the virtual account.

items.virtualAccount.name

string

required

The name of the virtual account.

items.virtualAccount.accountId

string

required

The account ID of the Slash account the virtual account is associated with.

items.virtualAccount.accountType

enum<string>

required

The account type of the virtual account. Since virtual accounts and Slash accounts exist at the same hierarchy level, an account type of 'primary' means it is the main Slash account, while an account type of 'default' means it is a virtual account under the main account.

Available options:

default,

primary

items.virtualAccount.accountNumber

string

The account number of the virtual account.

items.virtualAccount.routingNumber

string

The routing number of the virtual account.

items.virtualAccount.closedAt

string

The date the virtual account was closed; will be null if account was never closed.

items.balance

object

required

The total balance of the virtual account

items.balance.amountCents

integer

required

The amount in cents

items.spend

object

required

The total spend of the virtual account

items.spend.amountCents

integer

required

The amount in cents

items.commissionRule

object

The commission rule applied to the virtual account, if any

items.commissionRule.id

string

required

The ID of the commission rule

items.commissionRule.virtualAccountId

string

required

The ID of the virtual account the commission rule is applied to

items.commissionRule.commissionDetails

object

required

Describes details of the commission rule.

items.commissionRule.commissionDetails.type

enum<string>

required

The type of the commission rule. A type of flat_fee will take a flat fee from the virtual account and transfer it to the primary account with the frequency of the collection defined as monthly or yearly.

Available options:

flatFee

items.commissionRule.commissionDetails.amount

object

required

The amount of money to be diverted from the virtual account if the type of rule is flat_fee.

items.commissionRule.commissionDetails.amount.amountCents

integer

required

The amount in cents

items.commissionRule.commissionDetails.frequency

enum<string>

required

The frequency from the start date that the rule will be applied. E.g. a start date of November 26, 2024 with a frequency of "monthly" will have the rule applied on December 26, 2024. If the frequency was "yearly", the rule would be applied again on November 26, 2025.

Available options:

monthly,

yearly

items.commissionRule.commissionDetails.startDate

string

The date that the rule will begin to take effect.

metadata

object

Response sent when requesting a list of data

metadata.nextCursor

string

The cursor to use to retrieve the next page of data. If this is not sent, there is no more data to retrieve.

metadata.count

number

The number of items in the current page of data.

List account balances Create virtual account

twitter github linkedin