This API redeems an issued reward transaction, moving every user reward in the transaction from the ISSUED state to REDEEMED.

Use it to mark a reward as consumed once the customer has actually used it (for example, a voucher scanned in-store or a coupon applied at checkout). Only transactions in the ISSUED state can be redeemed.

The endpoint is gated by the brand-level REDEEM_ENABLE configuration flag, which is false by default. If the flag is not enabled for the org, the request is rejected. Raise a ticket with Product support to enable this for your organisation.

Example request

curl --location --request POST 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/user/reward/redeem?username={tillusername}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic <token>' \
  --data '{
    "txnId": 9876543210,
    "redeemedAtEventDateTime": "2026-05-13T09:32:11.000Z"
  }'

Prerequisites

• Authentication: Basic or OAuth authentication.
• The REDEEM_ENABLE Brand configuration flag must be set to true for the org. It is false by default and is managed through the brand configuration API.
• The reward transaction must be in the ISSUED state.

Request query parameters

Request body parameters

API Quick Reference

POST /api_gateway/rewards/core/v1/user/reward/redeem
   ├─ Request
   │   ├─ txnId (integer)
   │   └─ redeemedAtEventDateTime (string)
   └─ Response
       ├─ status
       │   ├─ success (boolean)
       │   ├─ code (integer)
       │   └─ message (string)
       ├─ txnId (integer)
       ├─ state (string)
       └─ userRewardCount (integer)

Example response

{
  "status": {
    "success": true,
    "code": 200,
    "message": "Reward redeemed successfully"
  },
  "txnId": 9876543210,
  "state": "REDEEMED",
  "userRewardCount": 1
}

Response parameters

Error codes