Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Check If Points Redeemable

get/points/isredeemable

Query parameters

mobilestring

Mobile number of the customer to check whether points are redeemable.

emailstring

Email ID of the customer to check whether points are redeemable.

external_idstring

External ID of the customer to check whether points are redeemable.

idinteger

Unique ID of the customer to check whether points are redeemable.

card_numberstring

Card number of the customer to check whether points are redeemable.

card_external_idstring

Card external ID of the customer to check whether points are redeemable.

program_idinteger required

Unique ID of the loyalty program from which points need to redeem.

group_redemptionboolean

Pass true for group redemption - points earned in one program need to redeem in a different program of the org.

pointsinteger required

Number of points to redeem.

issue_otpboolean

Pass true to issue OTP if the validation is successful.

validation_codestring

OTP issued to the customer’s mobile number.

skip_validationboolean

Pass true if you want to skip validation.

validation_type'MISSED_CALL' | 'SMS' | 'INVALID'

Preferred mode for validation. Use INVALID to skip validation.

user_group2_primary_user_idinteger

Unique user ID of the primary member of the group associated with the points to redeem.

user_group2_idinteger

Unique ID of the group associated with the points to redeem.

user_group2_primary_user_source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'MOBILE_APP'

Source in which the primary user’s identifier is available.

user_group2_primary_user_accountIdstring

Account ID of the source with multiple accounts such as WECHAT.

user_group2_primary_user_identifier_type'mobile' | 'email' | 'cardnumber' | 'cardExternalId' | 'id'

Identifier type used for the primary member.

user_group2_primary_user_identifier_valuestring

Value of the specified identifier type.

user_group2_external_idstring

Unique external ID of the group associated with the points to redeem.

use_default_user_group2boolean

Pass true to associate the default group with the points to redeem.

use_default_user_group2boolean

Pass true to consider the default user group.

format'xml' | 'json'

Preferred response format.

currency_inputboolean

Pass true whether the points of worth n can be redeemed. For example, you can check if points of worth $5 can be redeemed (assuming $ as the base currency). To use this, ensure that the org currency ratio is configured for the org.

currency_valueinteger

The currency amount to check. Required if currency_input=true.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "responses": {
      "points": {
        "mobile": "44700900999",
        "points_redeemed": "100",
        "redeemed_value": "100",
        "balance": "257",
        "item_status": {
          "success": "true",
          "code": "800",
          "message": "Points Redeemed"
        },
        "response": {
          "status": {
            "success": "true",
            "code": "200",
            "message": "SUCCESS"
          },
          "points": {
            "redeemable": {
              "mobile": "44700900999",
              "points": "100",
              "is_redeemable": "true",
              "points_redeem_value": 536,
              "points_redeem_local_value": 5239.79,
              "points_currency_ratio": "1",
              "item_status": {
                "success": "true",
                "code": "800",
                "message": "Points can be redeemed"
              }
            }
          }
        }
      }
    }
  }
}