Skip to main content

Redeem Reward

Redeem a reward on behalf of a loyalty member. Deducts the required points and marks the reward as redeemed.

When to Use

Use this endpoint when:

  • A member chooses to redeem a reward
  • Triggering reward redemption from your member UI

How to Use

Endpoint
POST/v3/loyalty/me/reward/{reward-id}/redeem

POST /v3/loyalty/me/reward/{reward-id}/redeem with countryCode and phoneNumber as query parameters.


Request Parameters

No request body. The reward is identified by the reward-id path parameter, and the member by the countryCode and phoneNumber query parameters.

Response Parameters

codeSTRING

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"