API Reference

REDEMPTIONS

The Redemption entity represents the process where a customer exchanges points for a reward.

⚠️

Note: All authenticated requests must include a valid bearer token in the

Authorization header:
Authorization: Bearer your-access-token You can obtain this token by authenticating with your client_id and client_secret_token at the endpoint /api/v1/auth/token. Once authenticated, use the returned token in all subsequent requests.


Key Capabilities

Create and update redemption records.

Validate redemptions via code or marking as used.

Fetch redemptions by customer or establishment.

Use Cases

Let users redeem rewards from a mobile app or POS.

Track status of redemptions (e.g., pending, used).

Analyze reward popularity or usage by location.