v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-067997411.3 KB

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

Query parameters

cursorstring

A cursor string to fetch the next page of results

filter:accountIdstring

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:includeClosedAccountsstring

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

Response

OK