redeem
POST
/api/v1/accounts/:account_id/customers/:customer_id/customer_cards/:id/redeem
Redeem a reward
Redeems a reward for a customer, deducting the required stamps from their card. The customer must have enough stamps on this card to cover the reward’s cost. Triggers wallet pass updates and push notifications.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id
|
Must be a number. | Required |
Store (account) ID |
customer_id
|
Must be a number. | Required |
Customer ID |
id
|
Must be a number. | Required |
Customer card ID |
reward_id
|
Must be a number. | Required |
Reward ID to redeem |
Error Codes
| Code | Description |
|---|---|
401
|
Unauthorized – invalid or missing API token |
404
|
Store, customer, customer card, or reward not found |
422
|
Redemption failed – not enough stamps or reward inactive |