Get Voucher By Code
Retrieve a single voucher's details by its code.
When to Use
▾
Use this endpoint when:
- Looking up a specific voucher for inspection or status check
- Verifying a voucher before redemption
How to Use
▾
/v3/voucher/{voucher_code}POST to /v3/voucher/{code} with no request body.
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
▾
Voucher object
Voucher key
Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIVCgdWb3VjaGVyGgpOQWtsRWZiVmRW"
label of voucher for merchant remarks
Example: "Free Breakfast"
Parent key of current voucher
Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQkvnGweaB2uQg"
Define type of vouchers: DISCOUNT, GIFT, CASH
Example: "GIFT"
Required if type = CASH, notation in cents, eg. RM 1.00 = 100
Example: 0
Required if type = DISCOUNT, notation without decimals, eg. 1% = 100
Example: 100
min amount to activate this voucher, required if type = CASH, DISCOUNT, notation in cents, eg. RM 1.00 = 100
Example: 100
SYSTEM (voucher code generated from RM server), SELF (voucher code uploaded from merchant csv file)
Example: "SYSTEM"
Image URL of current voucher, optional
Example: ""
Member profile of user's social media
Example: ""
Date time of voucher issuance (UTC)
Example: "2018-09-28T17:15:17Z"
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)
Voucher Code, members can keep this code for future redemption. Same as the qrURL below except this code is not a URL.
Example: "NAklEfbVdV"
True if items/goods to be delivered physically to customers
Example: false
Required if isShipping = true
Example: null
Expiry date time of current voucher
DYNAMIC (days from now), FIXED (specific fixed date)
Example: "DYNAMIC"
Only required by DYNAMIC expiry type. To indicate number of days from now until expiry.
Example: 30
Only required by FIXED. To indicate specific expiry date.
Example: "2020-10-07T17:44:26.679908+08:00"
Date time of voucher being voided (UTC)
Example: "GIFT"
Date time of voucher being redeemed (UTC)
Example: "GIFT"
TRUE means only can be redeemed through merchant app. FALSE means customer can do redemption from own loyalty app.
Example: false
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"
Date time of voucher being created (UTC)
Example: "2018-06-21T11:08:00Z"
Date time of voucher being updated (UTC)
Example: "2018-09-28T17:19:44.686549977Z"
Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)
Example: "SUCCESS"