Get Rewards

Method : GET
URL : https://open.revenuemonster.my/v3/loyalty/me/reward?countryCode=60&phoneNumber=187824152
Sandbox URL : https://sb-open.revenuemonster.my/v3/loyalty/me/reward?countryCode=60&phoneNumber=187824152

note
  • Using Query String to Get User Reward by input the country code and phone number
  • Using Query String to set a limit: ~/?limit=< limit >
  • To implement a pagination cursor, you may use query string: ~/?cursor= < cursor >
  • Example : https://open.revenuemonster.my/v3/loyalty/me/reward?countryCode=60&phoneNumber=187824152&limit=100&cursor=asdas

Request Parameters#

Example Request

curl --location --request GET "{{open_base_path}}/v3/loyalty/me/reward?countryCode=60&phoneNumber=187824152" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjIwMTgtMy0xOCIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiYXBpX2NsaWVudEBFaGNLQzA5QmRYUm9RMnhwWlc1MEVQZUEyYXJ4dk1PSUZnIl0sImV4cCI6MTU5MzU4MDY0NSwiaWF0IjoxNTkwOTg4NjQ1LCJpc3MiOiJodHRwczovL29hdXRoLnJldmVudWVtb25zdGVyLm15IiwianRpIjoiRWh3S0VFOUJkWFJvUVdOalpYTnpWRzlyWlc0UXMtNnI5LVgzbElvVyIsIm5iZiI6MTU5MDk4ODY0NSwic3ViIjoiRWhRS0NFMWxjbU5vWVc1MEVMUF9wNlNKNnFQN0ZSSVFDZ1JWYzJWeUVPaXZfb1dKNnFQN0ZRIn0.RKtXykw3y0ov3mKKa_K2h5FZB2jXtqf3gNRwwnzzA4xTMdY09mEHlFupMeUmchFW2XHYK254LdMYbF4ZhjxK9K51UUdQBYH-zZpo0WWtPSZqrPGtT-c4z_sEO73EDVcek3rDwyWiXvjSKDpsZM7NOdKRm5tvT3qNK-7C7WMUjSXDcBzbTFhwfOAOO1n-wMR9H_w0DuIE-yMjEZkOdt7GUIBC8F5izATlZH0FRTx4VAwQWY4gjjQ9-3PbUbHx-NKiFXwCOAsxu-79PiF0HDEHb6ZOCGywNmKuanEXqLonli0caZiUZfrdT53y3Xnd3W2SEr6s7ZQxWnQO5PeOU7BQYA" \
--header "X-Signature: sha256 bFGc2JOEFqdI91DE5VXYBUllr+9DHcrrylRFU3i1r72aPmJreljn0dU+nwPSwTH/dTQUiZ9C2aQSF8AuT959EW4WEyEZ6VWgt9gCyZaU/bcOQ/ZIhKc06+uwzivVhAzpbUtG5tm5/sBp4ig6Sk7L6SE0Ecu6Tm0FhYl0qdgZvrTh4EEpLs3kHIuYL9QXKJILfKlu4gTX1Exrt7nNyEr8ndeUMaKYrj3FckMbRtmCwc829SsVp6FAgvoDPnguUJ+VjLF1e9NXhar2JwYjuqMkwsmUWRDbittqCgCCfaPF8anarlLsoXbdYEa7bp9BYp2U/Dw3Xd2MlamEZSR8H+Dosw==" \
--header "X-Nonce-Str: VYNknZohxwicZMaWbNdBKUrnrxDtaRhN" \
--header "X-Timestamp: 1528450585" \

Response Parameters#

ParameterTypeDescriptionExample
itemsArrayRewards object(Refer to explanation below)
codeStringSuccessfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)"SUCCESS"
metaObjectInside meta have count key example "count": 2 2

Rewards object (item):
ParameterTypeDescriptionExample
idStringReward Id"1575971661443933008"
labelStringReward Label"Prudential RM 5 Cash Vouchers ( BoostPulse )"
imageUrlStringReward Image""
pointUintReward Point1
payloadObjectRefer to explanation below(Refer to explanation below)
isShippingBoolReward shippingfalse
quantityUintReward Quantity49998
balanceQuantityUintReward Balance Quantity49991
usedQunatityUintReward Used Quantity2
redeemQuantityStringReward Redeem Quantity7
isEnabledBoolEnable Rewardtrue
limitPerUserDateTimeSet Limit per User use1
statusStringReward status have ("COMPLETED", "INPROGRESS", "FAILED", "EXPIRED")"COMPLETED"
isComboBoolReward is Combofalse
typeStringReward type have Combo or Batch""
createdAtDateTimeCreate date time"2020-11-18T06:43:19Z"
updatedAtDateTimeLast update date time"2020-11-25T05:58:56Z"
expiredAtObjectExpired date time"2018-10-19T03:39:47Z"

Payload object:
ParameterTypeDescriptionExample
tncArray["T&C"]
contactInfoObjectRefer to explanation below(Refer to explanation below)

Contact Info object:
ParameterTypeDescriptionExample
emailStringEmail""
phoneNumberStringPhone Number""

Example Response

{
"items": [
{
"id": "1575971661443933008",
"label": "Prudential RM 5 Cash Vouchers ( BoostPulse )",
"imageUrl": "https://storage.googleapis.com/rm-sandbox-merchant/4118165203679668885/gallery/00c5184b36484d865372c1841f4cc4ce.jpeg",
"point": 1,
"payload": {
"tnc": ["T&C"],
"contactInfo": {
"email": "",
"phoneNumber": ""
}
},
"isShipping": false,
"quantity": 49998,
"balanceQuantity": 49991,
"usedQuantity": 2,
"redeemQuantity": 7,
"isEnabled": true,
"limitPerUser": 1,
"status": "COMPLETED",
"isCombo": false,
"type": "",
"createdAt": "2019-12-10T09:54:21Z",
"updatedAt": "2019-12-10T09:55:05Z",
"expiredAt": "2020-12-05T15:59:59Z"
}
],
"code": "SUCCESS",
"meta": {}
}