v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Redeem customer points

Redeem points for a customer from their individual or group wallet.

post/v2/customers/{id}/redemptions

Path parameters

idinteger required

Headers

Authorizationstring

X-CAP-API-OAUTH-TOKENstring

Request body

redemptionTypestring required

pointsnumber required

transactionNumberstring required

validationCodestring

sourcestring required

commitboolean required

skipValidationboolean

groupRedemptionboolean

externalReferenceNumberstring

notesstring

Example request

{
  "redemptionType": "POINTS",
  "points": 350,
  "transactionNumber": "TXN-882291",
  "validationCode": "VC-1234",
  "source": "INSTORE",
  "commit": true,
  "externalReferenceNumber": "TXN-882291"
}

Response

Successful redemption

warningsobject[]

errorsobject[]

successboolean

Example response

{
  "entity": {
    "redemptionId": "RDM-5002",
    "userId": 1003,
    "points": 100,
    "remainingPoints": 400,
    "redeemed": true,
    "crossMemberRedemptionBreakup": [
      {
        "memberId": 1001,
        "pointsRedeemed": 100,
        "expiryDate": "2026-04-05T00:00:00Z"
      }
    ]
  },
  "success": true
}