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
  }
}

GET

api

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

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

string

required

Unique identifier for this customer.

Response

data

object

required

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

Show child attributes