API Reference

Errors

HTTP Response Codes

Standard HTTP response codes are used for successful and failed responses.

  • 200 - Ok

  • 400 - Bad Request/Request parameter validation failed

  • 401 - Unauthorized/Expired

  • 402 - Insufficient Funds

  • 404 - Not Found

  • 405 - Method Not Allowed

  • 415 - Unsupported Media Type

  • 422 - Request failed due to invalid details

  • 429 - Too many requests

  • 500 - Internal Server Error

  • 503 - Backend Down/Maintenance

Response Body

In addition to the HTTP code response, an array of json objects will be returned in the response body. Each json response contains at least the following fields:

  • code (int)

  • status (string)

  • message (string)

  • request_id (string)

  • response (array/array of objects/null on errors)

{
  "code": 404,
  "status": "error",
  "message": "{error reason}",
  "request_id": "",
  "response" : null
}