Get Voucher By Code

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

note
  • Get Voucher detail by input {voucher-code}
  • Using Query String to input the country code and phone number

Request Parameters#

Example Request

curl --location --request GET "{{open_base_path}}/v3/loyalty/me/voucher/rms@xR43u4bRhUU?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
itemObjectVoucher object(Refer to explanation below)
codeStringSuccessfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)"SUCCESS"

Voucher object (item):
ParameterTypeDescriptionExample
keyStringVoucher Key (Internal Usage)"EhIKBk1lbWJlchDOuOKz24XWkg4SGQoNTWVtYmVyUHJvZmlsZRDl-MTxiPOPjzY"
labelStringVoucher Label"asdasd"
voucherBatchKeyStringVoucher Batch Key"EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQs4n7iuzioaQW"
typeStringVoucher Type ("CASH", "DISCOUNT", "GIFT")"CASH"
amountUintAmount of the voucher100
discountRateUintVoucher Discount Rate0
minimumSpendAmountUintSet a Minimum Spend Amount0
originStringOrigin is for determine voucher source ("SYSTEM", "SELF", "MARKETPLACE" )"SYSTEM"
imageUrlStringVoucher Image""
memberProfileObjectMember Profile (refer to profile page)null
assignedAtDateTimeVoucher Assign"0001-01-01T00:00:00Z"
payloadObjectRefer to explanation below(Refer to explanation below)
qrUrlStringVoucher QRcode URL""
codeStringVoucher Code"xR43u4bRhUU"
isShippingBoolVoucher Shippingfalse
addressObjectRefer to explanation below(Refer to explanation below)
expiryObjectExpiry date time(Refer to explanation below)
usedAtDateTimeVoucher Use"2020-11-25T13:58:55+08:00"
redeemedAtDateTimeVoucher Redeem"2020-11-25T04:33:04Z"
isDeviceRedeemBoolVoucher Redeem Devicetrue
statusStringVoucher Status ("VALID", "ISSUE", "REDEEMED", "VOID", "EXPIRED", "MARKET_PLACE")"VOID"
voucherComboKeyStringVoucher Combo Keynull
isMarketPlaceBoolLast update date timefalse
createdAtDateTimeCreate date time"2020-11-18T06:43:19Z"
updatedAtDateTimeLast update date time"2020-11-25T05:58:56Z"

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

Expiry object:
ParameterTypeDescriptionExample
typeStringVoucher Type ("DYNAMIC" , "STATIC")"DYNAMIC"
dayUintExpired Day1
expiredAtDateTimeVoucher Expired"2020-11-26T04:33:04Z"

Address object:
ParameterTypeDescriptionExample
addressLine1StringAddress 1""
addressLine2StringAddress 2""
postcodeStringPostcode""
cityStringCity""
stateStringState""
countryStringCountry""

Example Response

{
"code": "SUCCESS",
"item": {
"key": "EhQKCE1lcmNoYW50EJXVzd3wraqTORIcCgdWb3VjaGVyGhFybXNAeFI0M3U0YlJoVVUtMA",
"label": "asdasd",
"voucherBatchKey": "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQs4n7iuzioaQW",
"type": "CASH",
"amount": 100,
"discountRate": 0,
"minimumSpendAmount": 0,
"origin": "SYSTEM",
"imageUrl": "https://storage.googleapis.com/rm-sandbox-merchant/4118165203679668885/gallery/e136b2edca42f963a23b88ef699fa3cf.jpeg",
"memberProfile": null,
"assignedAt": "0001-01-01T00:00:00Z",
"payload": null,
"qrUrl": "",
"code": "rms@xR43u4bRhUU",
"isShipping": false,
"address": null,
"expiry": {
"type": "DYNAMIC",
"day": 1,
"expiredAt": "2020-11-26T04:33:04Z"
},
"usedAt": "0001-01-01T00:00:00Z",
"redeemedAt": "2020-11-25T04:33:04Z",
"isDeviceRedeem": true,
"status": "REDEEMED",
"voucherComboKey": null,
"isMarketPlace": false,
"createdAt": "2020-11-18T06:43:19Z",
"updatedAt": "2020-11-25T04:33:04Z"
}
}