Skip to main content
POST
/
loyalty
/
programs
/
{program_id}
/
rewards
/
{reward_id}
/
redeem
Redeem Reward
curl --request POST \
  --url https://webmaster.zupers.com.br/api/loyalty/v1/loyalty/programs/{program_id}/rewards/{reward_id}/redeem/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "cust_1234567890",
  "notes": "Customer preference: no onions"
}
'
{
  "success": true,
  "redemption_id": "redemption_987654321",
  "customer_id": "cust_1234567890",
  "reward": {
    "id": "reward_123456789",
    "name": "Free Burger",
    "description": "One free classic burger from our menu",
    "points_cost": 500,
    "available": true,
    "image": "<string>",
    "category": "Food"
  },
  "points_deducted": 500,
  "new_balance": 750,
  "redemption_code": "REDEEM-ABC123",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use format: Bearer ZsCUqECc9aCQtN5z9z9sTs81933YnklP

Path Parameters

​
program_id
string
required

Unique loyalty program identifier

Example:

"1474884f79a5ec42bc017be2aac"

​
reward_id
string
required

Unique reward identifier

Example:

"reward_123456789"

Body

application/json
​
customer_id
string
required
Example:

"cust_1234567890"

​
notes
string
Example:

"Customer preference: no onions"

Response

Reward redeemed successfully

​
success
boolean
Example:

true

​
redemption_id
string
Example:

"redemption_987654321"

​
customer_id
string
Example:

"cust_1234567890"

​
reward
object
​
points_deducted
integer
Example:

500

​
new_balance
integer
Example:

750

​
redemption_code
string
Example:

"REDEEM-ABC123"

​
timestamp
string<date-time>