Error Handling
The Blaze Partner API uses standard HTTP status codes and returns JSON error responses.
HTTP Status Codes
| Code | Meaning |
|---|---|
200 | Success |
400 | Bad Request — Invalid parameters or missing required fields |
401 | Unauthorized — Invalid or missing authentication credentials |
403 | Forbidden — Valid credentials but insufficient permissions |
404 | Not Found — The requested resource does not exist |
429 | Too Many Requests — Rate limit exceeded |
500 | Internal Server Error — Something went wrong on the server |
Error Response Format
Error responses return a JSON object with details about what went wrong:
{
"error": "Invalid argument",
"message": "startDate is required",
"status": 400
}
Common Errors
Invalid Arguments
Returned when request parameters fail validation (e.g., missing required fields, invalid date ranges, exceeding maximum limits).
{
"error": "Invalid argument",
"message": "Date range cannot exceed 7 days",
"status": 400
}
Authentication Errors
Returned when the Partner Key or Developer Key is missing or invalid.
{
"error": "Unauthorized",
"message": "Invalid partner key",
"status": 401
}
Permission Errors
Returned when the Partner Key does not have the required permission for the operation.
{
"error": "Forbidden",
"message": "Partner key does not have PERFORM_RECONCILIATION permission",
"status": 403
}
Best Practices
- Always check the HTTP status code before parsing the response body
- Implement retry logic with exponential backoff for
429and5xxresponses - Log error responses for debugging and support purposes
- Do not retry
400,401, or403errors — these require fixing the request