The ZBD API follows standard HTTP response codes for handling success and error requests.
HTTP status codes
Below is an overview of HTTP status codes available in the standard, which ZBD API adheres by:
|HTTP Response Group
|Status Code Range
Common response codes
These are the HTTP status codes most often returned by the ZBD API.
|Request was successful.
|Either incorrect or missing parameters provided for the Request.
|Request is not authorized. Make sure correct API Key is provided.
|Request is forbidden. Make sure your IP is located in a region/country that ZBD services are available in.
|The requested endpoint/resource was not found.
|The requested endpoint expected a specific parameter to be provided.
|Too many requests in short time-frame.
|Something went wrong in the ZBD API servers.
To help identify the issue with your API requests, the error JSON response returned will often include a message property that aims to be descriptive.
Example of an error message from the API:
"message": "Error creating Withdrawal Request: The \"amount\" property (in millisatoshis) is required.",