Skip to main content
A redemption spends a participant’s balance, either as a raw amount or against a catalog reward. It can capture immediately or authorize value into HELD for later fulfillment. A pending redemption moves through PENDING to COMPLETED, FAILED, or CANCELLED. A completed redemption can then move to PARTIALLY_REVERSED or FULLY_REVERSED. Reversals restore value to the participant and are capped at the remaining unreversed amount. Create and list redemptions under /v1/participants/{id}/redemptions. Get and resolve a specific redemption or manage reversals at /v1/redemptions/{id}. To redeem a gift card, send the chosen card value and currency in fulfillment on a catalog-item redemption. Scrip orders the card and completes the redemption. Use Create a claim link to give the participant access to a successfully ordered card.

​
Endpoints

  • Redeem a raw amount of an asset
  • Redeem a catalog item by reward_id, optionally with a fulfillment block
  • List and get redemptions for a participant
  • Create a claim link
  • Complete, fail, or cancel a pending redemption
  • List reversals on a redemption
  • Reverse a redemption (full or partial by amount)
For asynchronous fulfillment, see the Redemption lifecycle guide. For gift cards, see the Gift cards guide.