Redeem Points

post

https://api.zinrelo.com/v2/loyalty/transactions/redeem

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The API Rate Limiting Category is Write API. This endpoint will create a transaction of the type “redeem”. Redemption transactions are points debit transactions.

Please Note:

You can process only one redemption at a time. If you attempt to process two redemptions simultaneously, you will encounter the following error code:

"message": "A redemption request is already in process for the given member. Please try after some time."  
"code": ANOTHER_REDEMPTION_IN_PROGRESS  
"status_code": BAD_REQUEST(HTTP 400)

📘
This is the latest version of the Redeem API. If you are still using the older version, click here.

Query Params

language

string

One of the store languages, for example english/ italian/ german, etc.

Body Params

member_id

string

required

Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in Zinrelo.

reward_id

string

required

Unique ID that identifies a reward in Zinrelo. This is the ID of the reward against which the redemption transaction has to be recorded.

transaction_attributes

json

Every activity has a two predefined transaction attributes - reason and tags. While redeeming points for an activity, data can be passed in these attributes.

For example:

{
"reason" : "redeem",
"tags" : ["purchasenmade","redeemingpoints"]
}

Custom attributes: In addition to the predefined attributes, you can define custom attributes for each activity and pass data in those attributes.

The custom attribute should be created in advance. To create custom attributes for your store, reach out to your account manager at [email protected].

points_to_be_redeemed

integer

REQUIRED: only for flexible redemption. The number of points to be redeemed.

status

string

Pass the redemption status—approved or pending. If no entry is passed, the transaction will be redeemed, and its status will be approved.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

This is the latest version of the Redeem API. If you are still using the older version, click here.

200200

400400