Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Check if coupon is Redeemable

Lets you check whether a set of coupons can be redeemed or not.

get/coupon/is_redeemable

Query parameters

mobilestring

Mobile number of the customer.

details'true' | 'extended'

Pass =true to retrieve the details of the coupon series. details=extended retrieves the details of coupon configurations (set on campaign) of that specific coupon series.

emailstring

Email ID of the customer.

externalIdstring

Email ID of the customer.

cardnumberstring

Card number of the customer.

cardExternalIdstring

Card external ID of the customer.

idinteger

Unique ID of the customer.

codestring[] required

Pass the coupon code that you want to check for redemption. You can also pass multiple coupon codes separating each with a comma (,).

Response

200

OR
OR

Example response

{
  "redemption": [
    {
      "isRedeemable": true,
      "code": "UHI3T4V98MRGP0G0",
      "couponseries": {
        "description": "50% Off Holi Coupon",
        "discountCode": "NO_VALUE",
        "validTillDate": "2025-06-11T23:59:59Z",
        "info": "50% Off Holi Coupon",
        "discountValue": 200,
        "maxRedemptionsInSeriesPerUser": -1,
        "discountOn": "BILL",
        "discountType": "ABS",
        "validTilldateFormat": "2025-06-11"
      },
      "redemptionsLeft": -1,
      "numberOfRedemptionsByUser": 1,
      "discountType": "ABS",
      "discountValue": 200
    }
  ],
  "redemptionStatus": {
    "status": true,
    "code": 700,
    "message": "Coupon isRedeem successful"
  },
  "customer": {
    "id": 565039504,
    "profiles": [
      {
        "firstName": "Tom",
        "lastName": "Sawyer",
        "identifiers": [
          {
            "type": "email",
            "value": "tom.sawyer@capillarytech.com"
          }
        ],
        "userId": 565039504,
        "autoUpdateTime": "2025-05-02T09:25:19Z",
        "identifiersAll": [
          {
            "type": "email",
            "value": "tom.sawyer@capillarytech.com"
          }
        ]
      }
    ]
  }
}