Skip to main content
Our APIs use standard HTTP status codes to indicate the outcome of your requests. For more detailed information, error responses are returned in JSON format, containing specific error codes and messages.

Error Structure

When an error occurs, you receive a JSON object with the following structure:
Example
The response contains:
  • a failed status indicating that the API request was not processed successfully.
  • The error status_code .
  • The error message detailing what is wrong with the request.

Best Practices

  1. Log all API errors for easy debugging and issue resolution with the support team.
  2. Present your customers with actionable user-friendly messages so they are not stuck when they make an error.
  3. Implement retry logic for transient errors like 5xx errors or rate limiting.
  4. Report persistent or unexpected errors to our support team.