Dashboard
Support
Dashboard

Virtual Account

Get virtual account

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

Get virtual account

Retrieve a single virtual account by its ID.

GET

virtual-account

{virtualAccountId}

X-API-Key

string

X-API-Key

Required

string

Authentication from public API requests

virtualAccountId

string

virtualAccountId

Required

string

Authorizations

X-API-Key

string

headerrequired

Authentication from public API requests

Path Parameters

virtualAccountId

string

required

Response

200 - application/json

virtualAccount

object

required

The virtual account itself

virtualAccount.id

string

required

The ID of the virtual account.

virtualAccount.name

string

required

The name of the virtual account.

virtualAccount.accountId

string

required

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

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

virtualAccount.accountNumber

string

The account number of the virtual account.

virtualAccount.routingNumber

string

The routing number of the virtual account.

virtualAccount.closedAt

string

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

balance

object

required

The total balance of the virtual account

balance.amountCents

integer

required

The amount in cents

spend

object

required

The total spend of the virtual account

spend.amountCents

integer

required

The amount in cents

commissionRule

object

The commission rule applied to the virtual account, if any

commissionRule.id

string

required

The ID of the commission rule

commissionRule.virtualAccountId

string

required

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

commissionRule.commissionDetails

object

required

Describes details of the commission rule.

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

commissionRule.commissionDetails.amount

object

required

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

commissionRule.commissionDetails.amount.amountCents

integer

required

The amount in cents

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

commissionRule.commissionDetails.startDate

string

The date that the rule will begin to take effect.

Create virtual account Update virtual account

twitter github linkedin