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.

tip

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;

HTTP Response GroupStatus Code Range
Informational Responses100-199
Successful Responses200-299
Redirects300-399
Client Errors400-499
Server Errors500-599

ZEBEDEE HTTP Status Codes

As highlighted 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 CodeDetailsResponse Description
200SuccessRequest was successful.
400Bad RequestEither incorrect or missing parameters provided for the Request.
401UnauthorizedRequest is not authorized. Make sure correct API Key is provided.
404Not FoundThe requested endpoint/resource was not found. Make sure the API endpoint used is correct.
500Server ErrorSomething 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/errorString 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:

{
"message": "Error creating Withdrawal Request.",
"errorString": "Error: The \"amount\" property (in millisatoshis) is required."
}