API Errors

The API may return the following errors in the response. The message field varies depending on the context. Some errors may include a unique error_id to help with debugging internal issues.

Error Codes

Error Code	Description
`BAD_REQUEST`	The request was invalid or malformed.
`INTERNAL_ERROR`	An unexpected server error occurred.
`NOT_FOUND`	The requested resource (e.g., invoice) was not found.
`VALIDATION_ERROR`	Input validation failed (missing or invalid fields).
`MERCHANT_BLOCKED`	The merchant account is blocked and cannot perform this action.
`PLAN_UPGRADE_REQUIRED`	The merchant needs to upgrade their plan to perform this action.
`MAINTENANCE`	The API is temporarily unavailable due to maintenance.
`RATE_LIMIT_EXCEEDED`	The request was rejected because the client has exceeded the allowed number of requests in a given time period.

Example error responses

{
"error": {
  "code": "NOT_FOUND",
  "message": "Merchant not found",
  }
}

{
"error": {
  "code": "RATE_LIMIT_EXCEEDED",
  "message": "Rate limit exceeded",
  }
}

{
"error": {
  "code": "INTERNAL_ERROR",
  "message": "Internal server error",
  "error_id": "2de6e835-8a50-4e50-98ae-ce53cf66c042"
  }
}

{
"error": {
  "code": "NOT_FOUND",
  "message": "Upgrade your plan to business to access this endpoint",
  }
}

{
"error": {
  "code": "MAINTENANCE",
  "message": "We are currently performing maintenance. Please try again later",
  }
}