Skip to main content
GET
Get customer Z$ token balance

Authorizations

X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Path Parameters

id
string
required

Unique identifier for this customer.

Response

Customer's Z$ token balance and associated wallet address.

z_balance
string | null
required
wallet_address
string | null
required
has_wallet
boolean
required
error
string | null