Comment on page
Errors
We have standardized how we handle errors across all of our APIs.
When an error occurs, we will return information about why the error occurred as well as the corresponding HTTP error code.
A Validation error will occur if you send a request that is missing a parameter or has a parameter with an invalid/unacceptable value. In this situation, we will return the HTTP status code 400 (Bad Request) along with error details.
So, for example, if you tried to call our IBAN validation endpoint without specifying an IBAN value, you would get the following response:
GET /iban/validate
RESPONSE:
{
"message": "'query.iban' is required",
"field": "query.iban"
}
Whenever a validation error occurs your response will have the structure explained in the table below:
Key | Explanation | Type |
|---|---|---|
message | An explanation of why exactly the error happened. | string |
field | Contains the exact parameter name which failed validation. | string |
If you send a request to a non-existent endpoint, you will receive HTTP status code 404 (Not Found), and the following JSON response:
GET /non-existent-endpoint
RESPONSE:
{
"message": "No endpoint matching requested URL was found."
}
Whenever a Not Found Error occurs, your response will have the structure explained in the table below:
Key | Explanation | Type |
|---|---|---|
message | An explanation of why the error happened. | string |
If there is an error on our end, you will receive an error message that explains what happened. When an Internal Server Error occurs, our team members are alerted, and we investigate why it happened.
Whenever an Internal Server Error occurs, your response will receive a response having HTTP status 500 (Internal Server Error), and the JSON response explained in the table below:
Key | Explanation | Type |
|---|---|---|
message | An explanation of why the error happened. | string |
Our products are battle-tested and we ensure they are highly available. In case you have questions regarding any errors please contact our support team ([email protected]).
Last modified 1yr ago