Skip to main content
GET
List customer virtual accounts

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string
required
Example:

"cus_1A2b3C4d5E6f7G8h9I0jKl"

Query Parameters

cursor
string

Opaque cursor from a previous response. Send meta.nextCursor with direction=forward to read the next page, or meta.previousCursor with direction=backward to read the previous page.

limit
number
default:20

Maximum number of results to return (1-100)

Required range: 1 <= x <= 100
direction
enum<string>

Which side of the cursor to read: forward returns the rows after it, backward the rows before it. Rows come back in list order either way. Without a cursor, forward starts at the first row and backward at the end of the list.

Available options:
forward,
backward
asset
enum<string>

Filter to virtual accounts denominated in this asset code (e.g. USD). Case-insensitive.

Available options:
USD,
EUR,
GBP,
CHF,
JPY,
CAD,
AUD,
NZD,
SGD,
HKD,
CNY,
KRW,
INR,
BRL,
MXN,
ARS,
CLP,
COP,
PEN,
ZAR,
NGN,
KES,
GHS,
EGP,
AED,
SAR,
ILS,
TRY,
PLN,
CZK,
HUF,
SEK,
NOK,
DKK,
THB,
IDR,
MYR,
PHP,
VND,
TWD,
USDC,
USDT,
DAI,
EURC,
PYUSD,
OUSD,
BTC,
ETH,
SOL,
TRX,
XLM,
POL

Response

data
object[]
required
meta
object
required