Redeem Points

This API enables you to redeem points of a customer.

❗️

Make sure you have the appropriate access control configured. For more information, see access group documentation.

API endpoint

/v1.1/points/redeem


📘

If you are using validation code, make sure to use it within the validity period.

You can check the validity set for the validation code in OTP code validity period field on InTouch > Settings > Organization Setup > OTPConfigurations page.

Body parameters

ParameterDescription
redeemAn array containing objects representing individual redemption transactions
points_redeemedThe number of points that were redeemed in the transaction
transaction_numberUnique identifier for the transaction.
customerAn object containing information about the customer involved in the transaction
mobile*The mobile phone number of the customer
notesNotes or additional information about the transaction
validation_codeValidation code for the transaction.
custom_fieldsOrganization specific custom fields. Refer to the documentation on points redemption custom fields for more infromation.

Query parameters

ParameterDescription
user_group2_primary_user_id**Unique user ID of the primary member of the group associated with the points to redeem.
user_group2_id**Unique ID of the group associated with the points to redeem.
user_group2_external_id**Unique external ID of the group associated with the points to redeem.
user_group2_primary_user_sourceSource 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_accountIdAccount ID of the source with multiple accounts such as WECHAT.
user_group2_primary_user_identifier_typeIdentifier type used for the primary member.
Value: mobile, email, cardnumber, cardExternalId, id.
user_group2_primary_user_identifier_valueValue of the specified identifier type.
skip_validationPass true to skip customer validation to redeem points.
program_idUnique ID of the program from which points need to be redeemed. Applicable for orgs with multi-loyalty program enabled.
validation_typeValidation type used to redeem points.
Value: MISSED_CALL, SMS.

❗️

**

You must provide at least one of the parameters marked with ** for group level points redemption.

Response parameter

ParameterDescription
responseThe root object that contains all the details of the response
statusAn object containing the status details of the response
successA string indicating the success status of the response
codeThe HTTP status code associated with the response
messageA general message providing additional information about the status of the response
responsesAn object containing detailed response data
pointsAn object containing detailed information about the points involved in the transaction
mobileThe mobile phone number associated with the account involved in the transaction
emailThe email address associated with the account involved in the transaction
external_idAn external identifier for the transaction
user_idThe user ID associated with the account involved in the transaction
redemption_idA unique identifier for the redemption transaction
points_redeemedThe number of points that were redeemed in the transaction
redemption_purposeThe purpose of the redemption
redeemed_valueThe value of the points that were redeemed
redeemed_local_valueThe local value of the points that were redeemed
balanceThe remaining balance of points in the account after the redemption
side_effectsAn object containing information about any side effects of the redemption
effectAn array containing objects representing individual effects of the redemption
idA unique identifier for an individual effect
case_valueA string indicating whether a certain case is true for the effect
num_pointsThe number of points involved in the effect
currency_valueThe currency value associated with the effect
validation_codeA validation code associated with the effect
points_redemption_summary_idA summary ID associated with the points redemption
redeemed_on_bill_numberThe bill number associated with the redemption
redeemed_on_bill_idThe bill ID associated with the redemption
typeThe type of effect
item_statusAn object containing the status details of the item in the response
codeThe HTTP status code associated with the item status (800 indicates points were redeemed)
messageA general message providing additional information about the status of the item in the response
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!