Skip to content
Logo

api.customers.listAccounts

List every account attached to a single end-user customer. For an org-wide view, see api.accounts.list.

Filters take a single value each: currency: "USDC", rail: "base". Pass numeric ids (currency: 5) interchangeably with names.

const  = await ..("2f10…");
 
// Active USDC-capable accounts.
const  = await ..("2f10…", {
  : "USDC",
  : "active",
});
 
// Crypto-only.
const  = await ..("2f10…", {
  : "crypto",
});
 
// External-only on a given rail.
const  = await ..("2f10…", {
  : "external",
  : "base",
});

Arguments

ParamTypeNotes
customerIdstringThe customer UUID.
kind"fiat" | "crypto"?Narrow to one kind.
origin"external" | "virtual"?Narrow to one origin.
currencystring?Currency name ("USDC") or numeric id.
railstring?Rail name ("base") or numeric id.
status"pending" | "active" | "failed" | "closed"?Match exactly. closed returns retired accounts, which carry no details.
limitinteger (1–200, default 50)?Page size.
cursorstring?Opaque cursor from a prior page. Reserved: pagination tokens aren't emitted yet.

Returns: Promise<Account[]>.

REST endpoint: GET /customers/:id/accounts.