DEVELOPERS · API v1

Reward redemption

Public documentation. Partner access through Sales.

Contact Sales

Documentation / Reward redemption

Rewards are a pooled balance. The reward_id is your client-unique redemption reference, not a separately issued reward object.

Endpoint

POST /api/partner/v1/rewards/{reward_id}/redeem
Scope: stamps:write
Idempotency-Key: required
Success: 200

Request fields

FieldRequiredFormat
reward_idpath, required[A-Za-z0-9._-], 1–100
member_idrequiredmem_{id}, string ≤ 24
source_refrequiredstring ≤ 100

Request body

{"member_id":"mem_123","source_ref":"handover_100"}

Success response

{"member_id":"mem_123","balance":0,"rewards_available":0,"reward_id":"redemption_100","status":"redeemed"}

Redeem once

Consume a reward only when it is handed over. Exact retries do not consume another reward. Reusing reward_id or the member/source reference for another redemption returns 409. With no available reward, redemption returns 422. Existing rewards may still be redeemed while a business is suspended.

Your privacy

We use necessary storage for sign-in, security and preferences. No analytics or advertising trackers are enabled.

Necessary storage Always active
Keeps your session secure, remembers your language and stores your privacy choice.
Analytics and advertising
Not enabled. We do not use session replay or advertising cookies in this version.

This choice does not accept subscription terms or sign you up for marketing emails.

Legal and privacy centre