Check If Points Redeemable

Allows redeeming active points of customers according to the redemption criteria set for the organization (Loyalty Program). For example, you could set redemption criteria as allow redemption only in multiples of 10 and a maximum of 200 points per time.

This API lets you verify whether a specific number of points can be redeemed by a customer. With this API, you can now issue validation code to the customer automatically upon successful validation. This will reduce an additional step of calling /points/validationcode API to issue validation code.

📘

If there is any problem in issuing validation code, Points Redeemable but OTP Generation failed error will be displayed (876) * if points validation itself fails, then the relevant error message will be displayed

Prerequisites

  • Basic Authentication
  • Default access group

Resource information

URIv1.1/points/isredeemable?
HTTP methodGET
AuthenticationBasic
Pagination supported?NO
Rate limitYES
Batch supportNO

Request Parameters

Parameter (Parameters marked in * are mandatory)

Type

Description

mobile/email/external_id/card_number/card_external_id*

Enum

Pass any of the registered identifier type.

program_id*

long

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

group_redemption

boolean

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

points

int

Number of points to redeem.

issue_otp

boolean

Pass true to issue OTP if the validation is successful.

validation_code

string

OTP issued to the customer’s mobile number.

skip_validation

boolean

Pass true if you want to skip validation.

validation_type

Enum

Preferred mode of validation. Value: MISSED_CALL, SMS, INVALID. Use invalid if you want to skip_validation.

user_group2_primary_user_id

long

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

user_group2_id

int

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

user_group2_primary_user_source

Enum

Source in which the primary user’s identifier is available. Value: FACEBOOK, WEB_ENGAGE, WECHAT, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, MOBILE_APP.

user_group2_primary_user_accountId

string

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

user_group2_primary_user_identifier_type

Enum

Identifier type used for the primary member. Value: mobile, email, cardnumber, cardExternalId, id.

user_group2_primary_user_identifier_value

string

Value of the specified identifier type.

user_group2_external_id

string

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

use_default_user_group2

boolean

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

currency_input

boolean

Response Parameter

Parameter PathTypeDescription
responsebooleantrue if the request succeeded.
statusintegerHTTP status code (e.g., 200 for success).
-messagestringHuman-readable status message (e.g., "Success").
mobilestringCustomer’s registered mobile number (masked or full, based on configuration).
emailstringCustomer’s registered email address.
externalIdstringCustomer’s external identifier
pointsintegerPoints requested for redemption.
-is_redeemablebooleantrue if points are redeemable.
-points_redeem_valuedecimalEquivalent monetary value of redeemable points
-points_redeem_local_valuedecimalEquivalent monetary value in local currency (if conversion is enabled).
-input_typestringType of input (e.g., "points" or "currency").
points_currency_ratiostringConversion ratio between points and currency (e.g., "1").
-item_statusbooleantrue if points validation passed.
--codeintegerSub-status code for redemption checks (e.g., 800).
--messagestringDetailed message (e.g., "Points can be redeemed").
{
    "response": {
        "status": {
            "success": "true",
            "code": 200,
            "message": "Success"
        },
        "points": {
            "redeemable": {
                "mobile": "919777785205",
                "email": "[email protected]",
                "external_id": "434547",
                "points": 10,
                "is_redeemable": "true",
                "points_redeem_value": 10,
                "points_redeem_local_value": 10,
                "input_type": "points",
                "points_currency_ratio": "1",
                "item_status": {
                    "success": "true",
                    "code": 800,
                    "message": "Points can be redeemed"
                }
            }
        }
    }
}

API specific error codes

Error CodeDescriptionReason
889Points processing failed, Please try again later Reason : Failed to Connect to ServiceInvalid Customer identifiers passed
1101invalid programId passedInvalid programId passed
801Trying to redeem invalid pointsInvalid points parameter passed (e.g, negative points value)
818Current points are less than points requested for redemptionPoints redemption value is lesser than the current/existing points
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!