Error Handling
The ZEBEDEE API follows standard HTTP response codes for handling success and error requests. If you are unfamiliar with HTTP requests, please read more here.
HTTP response status codes indicate whether a specific HTTP request has been successfully completed.
HTTP Status Codes
Below is an overview of HTTP status codes available in the standard, which ZEBEDEE API adheres by:
| HTTP Response Group | Status Code Range |
|---|---|
| Informational Responses | 100-199 |
| Successful Responses | 200-299 |
| Redirects | 300-399 |
| Client Errors | 400-499 |
| Server Errors | 500-599 |
ZEBEDEE API Status Codes
As seen above, you are most likely to encounter the highlighted HTTP status codes ranges when interacting with the ZEBEDEE API. More details with the specific meaning of the status codes follow below:
| Status Code | Details | Response Description |
|---|---|---|
| 200 | Success | Request was successful. |
| 400 | Bad Request | Either incorrect or missing parameters provided for the Request. |
| 401 | Unauthorized | Request is not authorized. Make sure correct API Key is provided. |
| 403 | Forbidden | Request is forbidden. Make sure your IP is located in a region/country that ZEBEDEE services are available in (check Supported Regions page for more info). |
| 404 | Not Found | The requested endpoint/resource was not found. Make sure the API endpoint used is correct. |
| 500 | Server Error | Something went wrong in the ZEBEDEE API Servers. |
Error Messages
To help identify the issue with your API requests, the error JSON response returned will include a message property that aims to be descriptive. Follow the details from the message, alongside the API Reference / Documentation to resolve the issue.
Example of an error message from the API:
{
"success": false,
"message": "Error creating Withdrawal Request: The \"amount\" property (in millisatoshis) is required.",
}