Check If Points Redeemable

get

https://{host}/v1.1/points/isredeemable

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

mobile

string

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

string

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

external_id

string

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

int64

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

card_number

string

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

card_external_id

string

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

program_id

int64

required

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

int32

required

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

string

enum

Preferred mode for validation. Use INVALID to skip validation.

Allowed:

user_group2_primary_user_id

int64

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

user_group2_id

int32

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

user_group2_primary_user_source

string

enum

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

user_group2_primary_user_accountId

string

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

user_group2_primary_user_identifier_type

string

enum

Identifier type used for the primary member.

Allowed:

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 consider the default user group.

format

string

enum

Preferred response format.

Allowed:

currency_input

boolean

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_value

int32

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

Response

200200