Sign in

v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB
VirtualAccount

List all Virtual Accounts

List all Virtual Accounts across the organization. Spans every customer in the caller's organization; optionally filter by status and/or customer.

get/virtual-accounts

Query parameters

limitinteger
startingAfterstring
endingBeforestring
status'pending' | 'active' | 'frozen' | 'closed' | 'deleted' | 'failed' | 'inactiveActionRequired'

Lifecycle of a Virtual Account. pending: awaiting bank provisioning. active: accepting deposits. frozen: deposits held by compliance. inactiveActionRequired: destination unusable - re-point destination to recover. closed: permanently disabled. deleted: close flow finalized. failed: provisioning failed.

Filter by status.

customerIdstring

Filter to a single customer (cst_ prefix).

Response

The request has succeeded.

objectstring

Resource type discriminator.

hasMoreboolean

True when more rows exist beyond this page in the direction of travel (forward by default, backward when endingBefore was supplied).

nextCursorstring

Opaque cursor pointing at the last item in this page. Present when data is non-empty. Pass as startingAfter to fetch the next page; hasMore=false signals no more pages forward.

previousCursorstring

Opaque cursor pointing at the first item in this page. Present when data is non-empty. Pass as endingBefore to page backward; when this yields an empty response the client is at the start of the list.