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 KineticPay support.
HTTP Status Codes
The KineticPay API returns various status codes to indicate the result of a request. Familiarize yourself with these status codes to understand the outcome of your API calls.
- Name
200 OK- Type
- Description
The request was successful. This is the most commonly returned status code.
- Name
401 Unauthorized- Type
- Description
Authentication failed. This can occur due to an incorrect API Key, an API that is not enabled, or IP address restrictions. To resolve the issue, ensure that you have provided the correct API Key, verify the API's availability, and confirm that your IP address is authorized if necessary.
- Name
403 Forbidden- Type
- Description
Unprocessable Entity. You may encounter this status code when sending incomplete data in a POST or PATCH request.
- Name
404 Not Found- Type
- Description
The requested resource could not be found.
- Name
429 Too Many Requests- Type
- Description
You will receive this status code if you have exceeded the rate limits set by the API. Ensure you are within the allowed request limits.
- Name
500, 502, 503, 504 Server Errors- Type
- Description
If you encounter any of these status codes, it means there is an issue on our server-side. Make sure you have error handling mechanisms in place to handle these situations.