The API is RESTful and JSON-based. The API is accessed over the secure HTTPS protocol. For the full specification for the API please contact us.
Testing and Live Calls
The API contains methods with a MOCK postfix which indicates they are for testing purposes. These methods do not communicate with our backend and will retrieve preset data on GET calls. These methods can be used for instance to see if the calls to the API are succesful and to validate the formatting of the payload. Predefined test credentials (username test and password test) are used to authenticate and access these methods.
The other methods which are all calls to the LIVE system will a require the credentials of a valid client user account with permissions to the API for authentication.
In our API guide we will be looking at the functionality of the LIVE API methods.
Testing and Live Environments
Our API is available and running online on both testing and live environments. During the testing phase we recommended developers use the test environment to test their LIVE API calls so as to not be concerned about inadvertently creating data in the live system. Bear in mind that no payment and fund matching will occur on the testing environment, so the status on batches submitted will not progress past the InProgress phase in that environment.
Additionally, when you are issued with your API access credentials, you will be informed for which environment(s) they are valid.
• LIVE URL: - Availability : 24 / 7
• TESTING URL: - Availability : 10:00 – 16:00
NEED THE API SPEC DOCUMENT? PLEASE CONTACT US BELOW OR CAL LEON ON 0836071515