Transaction Network API Documentation

Transaction Network API Reference

The Transaction Network APIs are organised around REST, return JSON-encoded responses, and use standard HTTP response codes and verbs.

To access one of our APIs you will need to have credentials generated that you can use to authenticate your requests.

Testing can be performed by pointing at the sandbox environment. You will need credentials created in order to play in the sandbox and these will be different from your Production credentials.


Authentication


Errors

Transaction Network uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

  • Codes in the 2xx range indicate success.
  • Codes in the 4xx range indicate an error that failed due to the provided information or requested data not found.
  • Codes in the 5xx range indicate an error with the Transaction Network system.
HTTP Status Code Summary
200 The HTTP 200 OK success status response code indicates that the request has succeeded.
400 The HTTP 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing).
404 The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource.
500 The HTTP 500 Internal Server Error server error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Swagger

An unhandled error has occurred. Reload 🗙