Skip to main content
GET
List Virtual Accounts

Authorizations

Authorization
string
header
required

Bearer authentication with an API token

Path Parameters

identity_id
string
required

Identity whose virtual accounts to list.

Query Parameters

status
enum<string>

Only return virtual accounts with this status.

Available options:
VIRTUAL_ACCOUNT_STATUS_UNSPECIFIED,
VIRTUAL_ACCOUNT_STATUS_PENDING,
VIRTUAL_ACCOUNT_STATUS_ACTIVE,
VIRTUAL_ACCOUNT_STATUS_INACTIVE,
VIRTUAL_ACCOUNT_STATUS_FAILED
Example:

"VIRTUAL_ACCOUNT_STATUS_PENDING"

limit
string<int64>
default:10

The maximum number of virtual accounts to return in a single page.

cursor
string

Pagination cursor from a previous response, used to fetch the next page.

Response

Success

virtual_accounts
VirtualAccount · object[]
cursor
string