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

Request Parameters

ParameterTypeDescription
mobile/email/external_id/card_number/card_external_idEnumPass any of the registered identifier type.
program_idlongUnique ID of the loyalty program from which points need to redeem.
group_redemptionbooleanPass true for group redemption - points earned in one program need to redeem in a different program of the org.
pointsintNumber of points to redeem.
issue_otpbooleanPass true to issue OTP if the validation is successful.
validation_codestringOTP issued to the customer’s mobile number.
skip_validationbooleanPass true if you want to skip validation.
validation_typeEnumPreferred mode of validation.
Value: MISSED_CALL, SMS, INVALID.
Use invalid if you want to skip_validation.
user_group2_primary_user_idlongUnique user ID of the primary member of the group associated with the points to redeem.
user_group2_idintUnique ID of the group associated with the points to redeem.
user_group2_primary_user_sourceEnumSource 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_accountIdstringAccount ID of the source with multiple accounts such as WECHAT.
user_group2_primary_user_identifier_typeEnumIdentifier type used for the primary member.
Value: mobile, email, cardnumber, cardExternalId, id.
user_group2_primary_user_identifier_valuestringValue of the specified identifier type.
user_group2_external_idstringUnique external ID of the group associated with the points to redeem.
use_default_user_group2booleanPass true to associate the default group with the points to redeem.
currency_inputboolean
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!