Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Is Coupon Redeemable

get/coupon/isredeemable

Query parameters

mobilestring required

Mobile number of the customer.

emailstring

Email ID of the customer.

idinteger

Unique ID of the customer.

external_idstring

External ID of the customer.

card_numberstring

Card number of the customer.

card_external_idstring

Card external ID of the customer.

codestring required

Coupon code to validate.

details'true' | 'extended'

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

coupon_code_case''

This parameter helps to retrieve the coupon code in the desired letter cases. By default, the system automatically converts the coupon code to upper case. The query itself is not case sensitive. Supported Values: LOWER: Converts the coupon code to lower case. UPPER: Converts the coupon codes to upper case. AS_IT_IS: It ensure that the coupon code is retrieved exactly as it was created or provided, without altering the letter case. For instance, if the code is "abAB123," it should be retrieved and displayed as "abAB123," maintaining its original formatting.

Response

200

OR

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": 200,
      "message": "Success"
    },
    "coupons": {
      "redeemable": {
        "mobile": "11223569865",
        "code": "f3lru8",
        "is_redeemable": "true",
        "redemptions_left": -1,
        "coupon_value": "17",
        "customer": {
          "mobile": "11223569865",
          "external_id": "000003873472"
        },
        "item_status": {
          "success": "true",
          "status": "true",
          "code": 700,
          "message": "Coupon isRedeem successful"
        }
      }
    }
  }
}