Request Endpoint: https://sandbox.interswitchng.com/api/v2/quickteller/vouchers/redeem
| 1 | CustomerId | string | MAX | True | This is the customer Id that wants to redeem the voucher |
| 2 | CustomerMobile | string | MAX | false | This is the mobile contact of the customer who is trying to redeem the voucher |
| 3 | PaymentCode | string | 5 | True | This is the payment code of the biller |
| 4 | Amount | decimal | True | This is the amount of the voucher that wants to be redeemed | |
| 5 | CustomerEmail | string | 40 | False | The email of the customer |
| 6 | voucherCode | string | MAX | True | This is the voucher code we are trying to redeem |
Request Headers
{
"terminalId" :" 3DMO0001 ",
"Content-Type":"application/json",
"authorization":"InterswitchAuth SUtJQUYzRDNGMkQyMEY1MTM2REVGNUExMjUwMzZDN0U0QjgzMzgwQjBGMjA=",
"nonce":"a42a92fa5718bf480684cb75c3d25fb1",
"timeStamp":"1588858522",
"signature":"5+NUy30sMxQM3VzNIS/CPTkjixo=",
"signatureMethod":"SHA1"
}
Request Body
{
"customerId": "07039260209",
"customerEmail" :"test@u.com",
"customerMobile" :"2349124888776",
"paymentCode": "10803",
"amount": "50000",
"voucherCode":"180627935701032"
}
Sample Response (Success)
{
"TransactionRef": "PBL|Web|3PBL030|ZainPIN|261119163855|TVNRFWFPYT",
"RechargePIN": "7737373478847377",
"ApprovedAmount": "50000",
"MiscData": "7737373478847377",
"ResponseCode": "90000",
"ResponseDescription": "Success",
"ResponseCodeGrouping": "SUCCESSFUL"
}
Sample Response (Failed)
{"ResponseCode": "10001","ResponseDescription": "QT:3596578","ResponseCodeGrouping": "PENDING"}
Response Codes
| Response Code | Response Message |
|---|---|
| VS001 | VOUCHER_NOT_FOUND |
| VS002 | REDEMPTION_QUANTITY_EXCEEDED |
| VS003 | VOUCHER_IS_USED |
| VS004 | REDEMPTION_AMOUNT_EXCEEDED |
| VS006 | UNRECOGNISED_VOUCHER |
| VS018 | ACCESS_DENIED |
| VS020 | VOUCHER_NOT_STARTED |
| VS021 | NOT_AUTHORIZE_TO_REDEEM_VOUCHER |