Issue Voucher

Issue one or more vouchers from a voucher batch to customer(s). Each issued voucher gets a unique code.

When to Use

▾

Use this endpoint when:

• Distributing vouchers from a campaign batch to customers
• Manually issuing a voucher reward

How to Use

▾

Endpoint

POST/v3/voucher-batch/{batchkey}/issue

POST /v3/voucher-batch/{batchkey}/issue with the issuance details. The response includes the issued voucher code(s).

---

Request Parameters

▾

note

• The URL is consists of [base_URL]/v3/voucher-batch/[batchkey]/issue.

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

• [batchkey] can be retrieved by viewing at merchant portal or using endpoint Get voucher By Batches

• Pass an empty JSON object Example: {}

Response Parameters

▾

itemOBJECT

Voucher object

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"

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

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

Example: "SUCCESS"