Getting Started

Make API calls utilizing any language or tool that supports HTTPS POST requests. Requests should be application/x-www-form-urlencoded when posted to the appropriate endpoint. Responses can be processed through any native or 3rd party JSON parsing functionality/libraries.

At the top right hand corner of these documents you will see a switch. Make sure it is set to 'testing' in order for the endpoints in the documentation to reflect the sandbox endpoints. ALL TESTING SHOULD BE DONE IN THE SANDBOX. Sandbox accounts are provisioned automatically within approximately 6 hours of a client or user account being created and the sandbox panel can be accessed at API credentials, bank accounts and all other data must be added seperately in the sandbox for use with the sandbox.

API authentication details are required for every request. After acquiring authentication details, test your integration plan using our sandbox. Once your integration is tested, simply switch to our production server by changing the base URL for your API endpoints.

Note: If utilizing our PHP SDK, you can change your endpoint by passing the testing parameter as false.

Error Handling

Every API response will have a status value set to either 1 or 0 indicating if a request was successful. When a status of 0 is returned, the response will contain errors in it indicating the reason for the error. See the sample response below:

{"status":0,"errors":["First Error Message","Second Error Message"]}