pointsPrice from the member’s wallet; canceling one refunds those points.
This guide covers creating, fetching, and listing redemptions.
These are member-mode calls: they use the member token, not the
Org-API-Key. See Authentication. Whether the redemption
lands in sandbox or live is selected by the key the token was minted from - see
Environments.
Create a redemption
createRedemption(input, options/idempotencyKey?) calls
POST /v1/redemptions and returns 201 with the created Redemption. The body
is a CreateRedemptionRequest:
Redeeming debits the offer’s
pointsPrice from the member’s balance. If the
balance is below the price, the call fails with INSUFFICIENT_POINTS rather than
going negative.
curl
Safe retries with an idempotency key
Because creating a redemption spends points, always send anIdempotency-Key
header (the SDK accepts it via idempotencyKey). If a network blip makes you
retry, the server returns the original redemption instead of charging twice.
Reusing a key with a different body is rejected with IDEMPOTENCY_KEY_REUSED.
Fetch a redemption
getRedemption(id) calls GET /v1/redemptions/{id} and returns a single
Redemption:
curl
List redemptions
listRedemptions(...) calls GET /v1/redemptions and returns a
ListRedemptionsResponse with redemptions and a nextCursor. It accepts
limit, cursor, externalUserID, and a status filter. The snippet below
pages through a member’s OPEN redemptions:
ListRedemptionsResponse is cursor-paginated: follow nextCursor until it is
null. Treat the cursor as an opaque token.Status lifecycle
A redemption moves through these statuses as the experience is booked and fulfilled:Canceling a redemption refunds the debited points back to the member’s
wallet. See Points and wallet for how the balance
reflects debits and refunds.
Errors
Branch on the errorcode, never on message. The redemption-specific codes
are:
See Errors for the full taxonomy, the shared error shape, and
the
requestId you quote to support.
Next steps
Points and wallet
How debits and refunds move the member’s balance.
Retries and idempotency
The idempotency-key contract and automatic retry behavior.
Errors
Stable codes, the error shape, and the request id.