Errors
The Soldo Business API uses conventional HTTP response codes to indicate errors, with an error object containing a custom code and message for more detailed information on the error.
Error object
A consistent response is returned in cases where the request couldn't be processed. The error object is made of an error_code
, which contains a custom code to identify the error and a message
which provides more detailed information on the root cause of the error.
Example:
# HTTP Response Code: 400
{
"error_code": "WALLET_BALANCE_GREATER_THAN_ZERO",
"message": "Unable to delete, wallet has a balance greater than zero. You must transfer all funds to a different wallet before deleting it"
}
HTTP codes
Below is a list of standard HTTP response codes returned to the client in cases where the request couldn't be processed.
HTTP code | Description |
---|---|
400 | Bad Request - Your request is not as expected (e.g. it contains missing/invalid arguments). Common reasons: • Invalid fingerprint. • Invalid fingerprint signature. |
401 | Unauthorized - Your request is not authenticated. Common reasons: • Invalid credentials (UNAUTHORIZED). • Invalid access token (invalid_token). |
403 | Forbidden - The API credentials you're using don't have the necessary scopes to perform this request. To learn more about scopes and how to solve this issue see: Select your scopes. |
404 | Page Not Found - The endpoint requested does not exist. Check your spelling and the API reference (e.g. /employeee instead of /employees). |
405 | Method Not Allowed - An invalid method is being used. Check the API reference (e.g. PUT /cards/{cardId}/rules/countries instead of POST /cards/{cardId}/rules/countries). |
429 | Too Many Requests - You've hit the rate limit because too many requests were made in a short timeframe. Please wait and try again. To learn more about our rate limits see: Rate limits. |
500 | Internal Server Error - Something has failed on our end. Please reach out to our business support team. |
Updated 10 months ago