Get Voucher By Code

{% raw %}

POST/v3/voucher/{voucher_code}

Method : POST
Url :https://open.revenuemonster.my/v3/voucher/NAklEfbVdV
Sandbox Url : https://sb-open.revenuemonster.my/v3/voucher/NAklEfbVdV

To get single voucher by code

Request Parameters

• The URL is consists of [base_URL]/v3/voucher/[voucher_code].

• [base_URL] is the base URL depending on your environment (Sandbox or production)

• Pass an empty JSON object Example: {}

Response Parameters

itemObject

Voucher object

Example: (Refer to explanation below)

codeString

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

Example: "SUCCESS"

Voucher object (item):

keyString

Voucher key

Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIVCgdWb3VjaGVyGgpOQWtsRWZiVmRW"

labelString

label of voucher for merchant remarks

Example: "Free Breakfast"

voucherBatchKeyString

Parent key of current voucher

Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQkvnGweaB2uQg"

typeString

Define type of vouchers: DISCOUNT, GIFT, CASH

Example: "GIFT"

amountUint

Required if type = CASH, notation in cents, eg. RM 1.00 = 100

Example: 0

discountRateUint

Required if type = DISCOUNT, notation without decimals, eg. 1% = 100

Example: 100

minimumSpendAmountUint

min amount to activate this voucher, required if type = CASH, DISCOUNT, notation in cents, eg. RM 1.00 = 100

Example: 100

originString

SYSTEM (voucher code generated from RM server), SELF (voucher code uploaded from merchant csv file)

Example: "SYSTEM"

imageUrlString

Image URL of current voucher, optional

Example: ""

memberProfileString

Member profile of user's social media

Example: ""

assignedAtDateTime

Date time of voucher issuance (UTC)

Example: "2018-09-28T17:15:17Z"

qrUrlString

QR code for user to scan with Wechat or Facebook to add the voucher into their member account.

Example: QR Url link (refer to below code)

codeString

Voucher Code, members can keep this code for future redemption. Same as the qrURL below except this code is not a URL.

Example: "NAklEfbVdV"

isShippingBoolean

True if items/goods to be delivered physically to customers

Example: false

addressString

Required if isShipping = true

Example: null

expiryObject of Expiry

Expiry date time of current voucher

Example: (Refer below)

usedAtDateTime

Date time of voucher being voided (UTC)

Example: "GIFT"

redeemedAtDateTime

Date time of voucher being redeemed (UTC)

Example: "GIFT"

isDeviceRedeemBoolean

TRUE means only can be redeemed through merchant app. FALSE means customer can do redemption from own loyalty app.

Example: false

statusString

Status of current voucher: 1. Merchant created voucher batch (status=VALID)2. Merchant issued or going to transfer voucher to customer (status=ISSUED)3. Merchant shows voucher to customer and customer scans to get it (status=REDEEMED)4. Customers go back to shop and use the voucher (status=VOID)

Example: "VALID"

createdAtDateTime

Date time of voucher being created (UTC)

Example: "2018-06-21T11:08:00Z"

updatedAtDateTime

Date time of voucher being updated (UTC)

Example: "2018-09-28T17:19:44.686549977Z"

Expiry object (expiry):

typeString

DYNAMIC (days from now), FIXED (specific fixed date)

Example: "DYNAMIC"

dayUint

Only required by DYNAMIC expiry type. To indicate number of days from now until expiry.

Example: 30

expiryAtDateTime

Only required by FIXED. To indicate specific expiry date.

Example: "2020-10-07T17:44:26.679908+08:00"

{% endraw %}