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 details of current voucher
Expiry type: "FIX" (fixed expiry date) or "DYNAMIC" (relative to redemption)
Example: "DYNAMIC"
Number of days until expiry (used when type is DYNAMIC)
Example: 1
Expiry date time
Example: "2050-12-31T23:59:59Z"
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: ”"
True if this batch uses a single static voucher code
Example: false
Voucher's code
Example: "ABC123"
Additional voucher metadata
Terms and conditions
Example: ["Valid for dine-in only"]
Contact information for the voucher
Contact email (empty if not set)
Example: ""
Contact phone number (empty if not set)
Example: ""
TRUE means only can be redeemed through merchant app. FALSE means customer can do redemption from own loyalty app.
Example: false
Whether this voucher batch is hidden from listing
Example: false
Source of the voucher batch (empty if not from an external source)
Example: ""
Source type of the voucher batch (empty if not applicable)
Example: ""
Source prefix of the voucher batch (empty if not applicable)
Example: ""
Whether this voucher batch is from the marketplace
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"
Pagination metadata
Total number of voucher batches returned
Example: 3
Cursor for the next page (null if no more results)
Example: null