Get Voucher Batches
/v3/voucher-batchesList all voucher batches created by the merchant.
When to Use
▾
Use this endpoint when:
- Browsing batches to find a specific
batchkey - Building a batch-listing UI in your dashboard
How to Use
▾
/v3/voucher-batchesGET /v3/voucher-batches. No request body required.
Request Parameters
▾
No request body. Authenticated headers only.
Response Parameters
▾
Voucher object array
Voucher ID
Example: “6544507929221794245"
Voucher Key
Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIVCgdWb3VjaGVyGgpOQWtsRWZiVmRW"
label of voucher for merchant remarks
Example: "Free Breakfast”
Define type of vouchers: DISCOUNT, GIFT, “CASH"
Example: “GIFT"
Required if type = CASH, notation in cents, eg. RM 1.00 = 100
Example: 10000
Required if type = DISCOUNT, notation without decimals, eg. 1% = 100
Example: 0
Minimum spend amount
Example: 0
Image URL of current voucher, optional
Example: Image Url link (refer to below code)
Total quantity of voucher(s) in this batch
Example: 1
Total quantity of voucher(s) remaining in this batch
Example: 0
Total quantity of voucher(s) used/assigned/redeemed in this batch
Example: 1
Voucher's status
Example: "COMPLETED"
Expiry date time of current voucher
Example: (Refer below)
SYSTEM (voucher code generated from RM server), SELF (voucher code uploaded from merchant csv file)
Example: “SYSTEM”
True if items/goods to be delivered physically to customers
Example: false
Will show if voucher batch is fail during creation. Optional.
Example: ”"
Voucher's code
Example: "ABC123"
TRUE means only can be redeemed through merchant app. FALSE means customer can do redemption from own loyalty app.
Example: false
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"