curl --request PATCH \
--url https://staging-vouchers.ventogram.com/api/v1/vouchers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--data '{
"email": "<string>",
"voucherCode": "<string>"
}'
{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"email": "<string>",
"voucherCode": "<string>",
"amount": 123,
"fee": 123,
"wavedFee": 123,
"merchant": "<string>",
"currency": "NGN",
"feeBearer": "client",
"toAmount": 123,
"fromAmount": 123,
"fromCurrency": "<string>",
"toCurrency": "<string>",
"rate": 123,
"previousBalance": 123,
"currentBalance": 123
}
}
Redeems an existing unused voucher
curl --request PATCH \
--url https://staging-vouchers.ventogram.com/api/v1/vouchers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--data '{
"email": "<string>",
"voucherCode": "<string>"
}'
{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"email": "<string>",
"voucherCode": "<string>",
"amount": 123,
"fee": 123,
"wavedFee": 123,
"merchant": "<string>",
"currency": "NGN",
"feeBearer": "client",
"toAmount": 123,
"fromAmount": 123,
"fromCurrency": "<string>",
"toCurrency": "<string>",
"rate": 123,
"previousBalance": 123,
"currentBalance": 123
}
}
successful operation
The response is of type object
.