List virtual accounts

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Query Parameters

cursor

string

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limit

integer

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

Required range: 1 <= x <= 100

sort

enum<string>

default:createdAt

Field to order the page by. createdAt is descending unless sortDirection is passed. See Sorting.

Available options:

createdAt

sortDirection

enum<string>

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

Available options:

asc,

desc

accountId

string

Return virtual accounts in one accessible Account.

includeClosed

boolean

default:false

Include closed virtual accounts. Defaults to false.

Response

A page of virtual accounts.

items

VirtualAccount · object[]

required

Hide child attributes

items.id

string

required

Virtual account id with the subaccount_ prefix.

items.name

string

required

items.accountId

string

required

Parent Account id with the sa_group_ prefix.

items.accountType

enum<string>

required

Available options:

primary,

default

items.status

enum<string>

required

Available options:

open,

closed

items.balance

Money · object

required

Current ledger balance. Zero for a newly created virtual account.

Hide child attributes

items.balance.amount

integer

required

Amount in the currency's minor units.

items.balance.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.commission

Flat fee · object

Funds diverted to the Account's primary virtual account.

Flat fee
Take rate

Hide child attributes

items.commission.id

string

required

Commission configuration id.

items.commission.type

enum<string>

required

Available options:

flat_fee

items.commission.amount

UsdMoney · object

required

Fixed USD amount collected each period.

Hide child attributes

items.commission.amount.amount

integer

required

Amount in cents. For example, 1250 represents USD 12.50.

Required range: x >= 1

Example:

1250

items.commission.amount.currency

enum<string>

required

Available options:

USD

items.commission.frequency

enum<string>

required

Available options:

monthly,

yearly

items.commission.startsAt

string<date-time>

RFC 3339 date and time when collection begins.

metadata

PaginationMetadata · object

required

Hide child attributes

metadata.count

integer

required

Number of items in this page.

Required range: x >= 0

metadata.nextCursor

string

Opaque cursor for the next page. Omitted on the final page.

Banking

Money movement

Cards

Bill pay

Invoicing

Accounting

Platform

List virtual accounts

Authorizations

Headers

Query Parameters

Response