Rewards Catalog API
note
Full API endpoint documentation will be sourced from the codebase. The table below reflects known endpoints.
Endpointsβ
| Method | Path | Description |
|---|---|---|
GET | /v1/rewards | List all active rewards available for the customer |
GET | /v1/rewards/:id | Get details for a specific reward |
POST | /v1/rewards/:id/redeem | Redeem a reward for the authenticated customer |
GET | /v1/customers/:id/reward_transactions | List all reward redemptions for a customer |
Redemption Requestβ
POST /v1/rewards/:id/redeem
{
"customer_id": "cust_123",
"quantity": 1
}
Redemption Responseβ
On success, returns the redemption transaction including:
transaction_idβ unique identifier for the redemptioncodeβ the reward code assigned (if applicable)points_spentβ points deducted from the customer's balanceremaining_balanceβ customer'sscore_availableafter redemption