Skip to main content
GET

Errors

Plus the shared errors — see Accounts errors.

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer the account belongs to. Must be a cus_… reference id, and must belong to your partner account. Blank → 400 ERRACC_1000; malformed, unknown, soft-deleted or another partner's → 404 ERRREF_1001.

Example:

"cus_9HqA2mT7xK4vRb1NdLpZ"

Query Parameters

listAllActive
boolean

When true, returns all activated accounts across providers; otherwise only activated non-crypto accounts. Silently ignored when status is supplied.

status
enum<string>[]

Filter by account status. Repeatable (?status=ACTIVE&status=DEACTIVATED) or comma-separated. Case-insensitive. An unknown value → 400 ERRACC_1005.

Available options:
ACTIVE,
PENDING,
DEACTIVATED,
CLOSED,
FROZEN,
UNDER_REVIEW,
DORMANT

Response

Returns all of a customer's accounts, plus balances grouped by category.

data
object[]
required

The accounts. Each element is a PartnerAccount without fundingInstructions.

balances
object
required

Balances grouped by account category. Keys are FIAT and ONRAMP — a key appears only if that category is present in the result. {} when nothing matched.