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 ParametersExample Request
#
Response ParametersParameter | Type | Description | Example |
---|---|---|---|
item | Object | Voucher object | (Refer to explanation below) |
code | String | Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes ) | "SUCCESS" |
Voucher object (item):
Parameter | Type | Description | Example |
---|---|---|---|
key | String | Voucher Key (Internal Usage) | "EhIKBk1lbWJlchDOuOKz24XWkg4SGQoNTWVtYmVyUHJvZmlsZRDl-MTxiPOPjzY" |
label | String | Voucher Label | "asdasd" |
voucherBatchKey | String | Voucher Batch Key | "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQs4n7iuzioaQW" |
type | String | Voucher Type ("CASH", "DISCOUNT", "GIFT") | "CASH" |
amount | Uint | Amount of the voucher | 100 |
discountRate | Uint | Voucher Discount Rate | 0 |
minimumSpendAmount | Uint | Set a Minimum Spend Amount | 0 |
origin | String | Origin is for determine voucher source ("SYSTEM", "SELF", "MARKETPLACE" ) | "SYSTEM" |
imageUrl | String | Voucher Image | "" |
memberProfile | Object | Member Profile (refer to profile page) | null |
assignedAt | DateTime | Voucher Assign | "0001-01-01T00:00:00Z" |
payload | Object | Refer to explanation below | (Refer to explanation below) |
qrUrl | String | Voucher QRcode URL | "" |
code | String | Voucher Code | "xR43u4bRhUU" |
isShipping | Bool | Voucher Shipping | false |
address | Object | Refer to explanation below | (Refer to explanation below) |
expiry | Object | Expiry date time | (Refer to explanation below) |
usedAt | DateTime | Voucher Use | "2020-11-25T13:58:55+08:00" |
redeemedAt | DateTime | Voucher Redeem | "2020-11-25T04:33:04Z" |
isDeviceRedeem | Bool | Voucher Redeem Device | true |
status | String | Voucher Status ("VALID", "ISSUE", "REDEEMED", "VOID", "EXPIRED", "MARKET_PLACE") | "VOID" |
voucherComboKey | String | Voucher Combo Key | null |
isMarketPlace | Bool | Last update date time | false |
createdAt | DateTime | Create date time | "2020-11-18T06:43:19Z" |
updatedAt | DateTime | Last update date time | "2020-11-25T05:58:56Z" |
Payload object:
Parameter | Type | Description | Example |
---|---|---|---|
tnc | Array | ["T&C"] | |
contactInfo | Object | Refer to explanation below | (Refer to explanation below) |
Expiry object:
Parameter | Type | Description | Example |
---|---|---|---|
type | String | Voucher Type ("DYNAMIC" , "STATIC") | "DYNAMIC" |
day | Uint | Expired Day | 1 |
expiredAt | DateTime | Voucher Expired | "2020-11-26T04:33:04Z" |
Address object:
Parameter | Type | Description | Example |
---|---|---|---|
addressLine1 | String | Address 1 | "" |
addressLine2 | String | Address 2 | "" |
postcode | String | Postcode | "" |
city | String | City | "" |
state | String | State | "" |
country | String | Country | "" |
Example Response