Skip to main content
GET
/
api
/
v2
/
customers
/
{id}
/
z-balance
Get customer Z$ token balance
curl --request GET \
  --url https://api.zupy.com/api/v2/customers/{id}/z-balance/ \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "z_balance": "<string>",
    "wallet_address": "<string>",
    "has_wallet": true,
    "error": "<string>"
  },
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for partner access via APISIX key-auth plugin

Path Parameters

id
string
required

Unique identifier for this customer.

Response

data
object
required

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

meta
object
required

Cursor-based pagination metadata matching envelope middleware output.