Our JSON + RESTful API allows developers to build custom tools, services, and applications (for use on web, mobile, desktop, and POS) on top of our gateway, with most of the features available on the main Akatua website.

The API is based on Representational State Transfer (REST) architectural style, making it very fast and simple to implement. The API also makes extensive use of JavaScript Object Notation (JSON) for both requests made to the service and responses returned by it.

Getting Application Credentials

In order to start using our API, one needs application credentials, which can be obtained by following these steps:

  • Login to your Akatua account, or Sign up if you don't have one.
  • While logged in, click on Applications under Integration.
  • Click on Create New App and provide basic information about your application.
  • Grant your application the necessary permissions (very important)
  • Select an appropriate Status (in this case, Enabled) and click on "Add" to create your application.

If all goes well, an Application ID and Application Secret will be generated for your new application.

Authentication

Our API requires authentication for every request made to it, making it necessary for every API call to send the authentication parameters along with it. Authentication is done by presenting the following HTTP headers in each of your requests.

Content-Typemust always be "application/json"
Akatua-Application-IDApplication ID generated above, that uniquely identifies your application
Akatua-SignatureUnique hmac-sha256 hash generated for each request. This is generated by hashing (hmac-sha256) the entire JSON request object, using your Application Secret as the hmac key.

API Response

All responses returned by the API are presented using the following parameters:

successtrue. This is only returned if the request was successful.
responseThe actual response returned by the API. This is only available if success is true.
errortrue. This is only returned if the request was unsuccessful.
errorTextdescription of the error (only available if error is true)
errorCodeUnique error code (only available if error is true)
  • Both success and error will never be returned by the API, so it's either one or the other.
  • These parameters are returned in addition to other transaction-specific parameters.