POST /v1/vouchers/redeem
4.1. POST /v1/vouchers/redeem
Body:
{
"qr": "QR_CODE_CONTENT_SCANNED"
"metadata": "branch_code:123,pos_ID:456,cashier_ID:001,receipt_number:789,SKU:001,002"
}
Note: Do not alter the QR string as shown in the documentation and metadata, or enforce any conditions on the voucher ids.
SKU:
and receipt_number:
are only required for Climate Vouchers programme. It is mandatory, and the format should follow the above example specifically for these 2 details. Do note to only include eligible items’ SKUs.
Response:
{
"status": "succeeded", // To be deprecated
"vouchers": {
"voucher_value": 10,
"timestamp": "2022-02-31T00:00:00.000+08:00"
}, // To be deprecated
"campaign": {
"id": "campaign_052ef9cc-5c46-4dc7-97d6-fb4564f65fdf",
"name": "My Test Campaign"
},
"transaction": {
"id": "transaction_e1f4e74d-29a0-48b5-80ae-ee40764e1bd5",
"value": 10,
"created_at": "2022-02-31T00:00:00.000+08:00"
}
}
Ignore the keys status
and vouchers
as they are to be deprecated.
Last updated