Skip to main content

Error Response Format

All errors return JSON:
{
  "success": false,
  "error": "error_code",
  "message": "Human-readable message",
  "details": { "field": ["Validation message"] }
}

HTTP Status Codes

CodeMeaningTypical cause
200OKSuccess
201CreatedResource created
400Bad RequestInvalid parameters
401UnauthorizedInvalid or missing HMAC / API key
403ForbiddenPlan insufficient or subscription inactive
404Not FoundResource not found
422Unprocessable EntityValidation failed
429Too Many RequestsRate limit exceeded
500Server ErrorInternal error

Common Errors

  • 401 Invalid Signature: Check payload format METHOD|URI|BODY|TIMESTAMP, timestamp within 5 minutes, correct HMAC secret.
  • 403 Plan insufficient: Upgrade to API plan or higher at Billing.
  • 429 Rate limit: Wait for Retry-After seconds; consider upgrading plan.
Always check success and handle error / message in your client.