Skip to main content

Get Reward By ID

Retrieve full details of a single reward by reward-id for a specific loyalty member.

When to Use

Use this endpoint when:

  • Showing a single reward's details (image, point cost, expiry)
  • Confirming the reward before a member redeems it

How to Use

Endpoint
GET/v3/loyalty/me/reward/{reward-id}

GET /v3/loyalty/me/reward/{reward-id} with countryCode and phoneNumber 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

itemOBJECT

Reward object

idSTRING

Reward ID

Example: "1575971661443933008"

labelSTRING

Reward Label

Example: "Prudential RM 5 Cash Vouchers ( BoostPulse )"

imageUrlSTRING

Reward Image

Example: ""

pointINTEGER

Reward Point

Example: 1

payloadOBJECT

Refer to explanation below

tncARRAY

Example: ["T&C"]

contactInfoOBJECT

Contact Info

emailSTRING

Email

Example: ""

phoneNumberSTRING

Phone Number

Example: ""

isShippingBOOLEAN

True if items/goods to be delivered physically to customers

Example: false

quantityINTEGER

Reward Quantity

Example: 49998

balanceQuantityINTEGER

Reward Balance Quantity

Example: 49991

usedQuantityINTEGER

Reward Used Quantity

Example: 2

redeemQuantitySTRING

Reward Redeem Quantity

Example: 7

isEnabledBOOLEAN

Enable Reward

Example: true

limitPerUserINTEGER

Set Limit per User use

Example: 1

statusSTRING

Reward status have ("COMPLETED", "INPROGRESS", "FAILED", "EXPIRED")

Example: "COMPLETED"

isComboBOOLEAN

Reward is Combo

Example: false

typeSTRING

Reward type have Combo or Batch

Example: ""

createdAtDATETIME

Create date time

Example: "2020-11-18T06:43:19Z"

updatedAtDATETIME

Last update date time

Example: "2020-11-25T05:58:56Z"

expiredAtDATETIME

Expired date time

Example: "2018-10-19T03:39:47Z"

codeSTRING

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

Example: "SUCCESS"