Get Rewards
List a loyalty member's available rewards. Supports limit and cursor-based pagination.
When to Use
▾
Use this endpoint when:
- Displaying a member's reward catalog
- Building a rewards page in your member-facing UI
How to Use
▾
/v3/loyalty/me/rewards?countryCode={countryCode}&phoneNumber={phoneNumber}GET with countryCode, phoneNumber, optional limit, and optional cursor as query parameters.
Request Parameters
▾
No request body. The member is identified by the countryCode and phoneNumber query parameters.
Response Parameters
▾
Rewards object
Example: (Refer to explanation below)
Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)
Example: "SUCCESS"
Inside meta have count key example "count": 2
Example: 2
item:
Reward Id
Example: "1575971661443933008"
Reward Label
Example: "Prudential RM 5 Cash Vouchers ( BoostPulse )"
Reward Image
Example: ""
Reward Point
Example: 1
Refer to explanation below
Example: ["T&C"]
Refer to explanation below
Example: ""
Phone Number
Example: ""
Reward shipping
Example: false
Reward Quantity
Example: 49998
Reward Balance Quantity
Example: 49991
Reward Used Quantity
Example: 2
Reward Redeem Quantity
Example: 7
Enable Reward
Example: true
Set Limit per User use
Example: 1
Reward status have ("COMPLETED", "INPROGRESS", "FAILED", "EXPIRED")
Example: "COMPLETED"
Reward is Combo
Example: false
Reward type have Combo or Batch
Example: ""
Create date time
Example: "2020-11-18T06:43:19Z"
Last update date time
Example: "2020-11-25T05:58:56Z"
Expired date time
Example: "2018-10-19T03:39:47Z"