Using this API, you will be able to check a voucher’s current value.

Configuration

The configuration for the Voucher API calls can be seen below.

NOTE: When testing, please use the SANDBOX API URL.

The configuration for the Voucher API calls can be seen below.

Parameters

 

Test Parameters

You may use these parameters to make a test Voucher API call using the Sandbox API URL.

Responses

All Voucher API calls return a JSON object. There are two main types of responses; “success” and “error“. These response types can be found in the value of the “status” key in the JSON response object

Success

If all submitted data is valid, you will receive a JSON response object indicating a “success” value for the “status” key. Below is an example of a successful transaction using the Voucher API.

{

    "status": "success",
    "msg": "Voucher check successful",
    "value": "0.00"

}

Error

“error” responses may be received for various reasons. Check the value of the “msg” key in the JSON response object to diagnose what your specific error may be caused by. The following is an example of  an “error” response.

{
    "status": "error",
    "msg": "Invalid Voucher"
}

The possible values of the “msg” key in an “error” type response are as follows: