API Reference

The AddPay Web API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your client ID and secret API credentials in any public website's client-side code). JSON is returned by all API responses, including errors.

To make the API as explorable as possible, accounts have test mode and live mode API credentials. There is no "switch" for changing between modes, just use the appropriate key to perform a live or test transaction on the live or test endpoints. Requests made with test mode credentials never hit the banking networks and incur no cost.

Live API Endpoint: https://secure.addpay.co.za/v2/

Test API Endpoint: https://secure-test.addpay.co.za/v2/

Response Dates

All dates in response payloads will be returned in UTC timezone based date stamp in ISO-8601 format.

If the knowledge base does not cover an inquiry you may have, please Create a New Support Ticket.