Skip to main content
POST
/
api
/
v2
/
customers
/
{id}
/
rewards
/
{reward_id}
/
redeem
Redeem a reward for a customer
curl --request POST \
  --url https://api.zupy.com/api/v2/customers/{id}/rewards/{reward_id}/redeem/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "use_z_tokens": false
}
'
{
  "data": {
    "customer_id": "<string>",
    "coupon_code": "<string>",
    "points_used": 123,
    "z_tokens_used": "<string>",
    "new_balance": 123,
    "new_z_balance": "<string>",
    "valid_until": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "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.

reward_id
string
required

Body

Reward redemption request parameters.

use_z_tokens
boolean
default:false

Response

data
object
required

Reward redemption result with generated coupon code and points/Z$ deducted.

meta
object
required

Cursor-based pagination metadata matching envelope middleware output.