Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Payox support.

Status codes

Here is a list of the different categories of status codes returned by the Payox API. Use these to understand if a request was successful.

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error — this means it's a you problem.
Name
5xx
Description
A 5xx status code indicates a server error — you won't be seeing these.

Error types

Whenever a request is unsuccessful, the Payox API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the Payox API use these to understand what you have done wrong.

Name
error_invalid_sign
Description
403 Unfortunately, the signature you created is not correct. Check the parameters you sent and your signature function.
Name
error_site_not_found
Description
404 No integration was found for the appKey value you sent. Or our system administrator may have disabled your integration.
Name
not_authorized
Description
403 IP Whitelist error.Your IP address is unauthorized to create a Withdraw operation.
Name
error_transaction_blacklisted
Description
403 The information of the member with whom you created a transaction has been blacklisted.
Name
error_invalid_bank
Description
404 The bankId parameter you sent is incorrect.
Name
bankAccount_not_found
Description
400 We could not find an account to assign according to the amount under the 'bankId' to which you sent your deposit transaction.
Name
internal_server_error
Description
500 An unexpected problem occurred and our system administrators were notified. Please try again later.

Error response

  {
      "data": {
          "errMessage": "error_site_not_found"
       },
      "status": 404,
      "responseTime": "5ms",
      "app_version": "payox-v1.7.3"
  }