Errors

Cobrofácil API errors use a consistent JSON response format. Every error response includes a human-readable message, and JSON exception responses also include an exception_code integer. Validation errors include an additional errors object keyed by field name.

Use the HTTP status code to decide how your integration should react, and use the response body to show or log the specific reason.

Error response shape

{
  "message": "Unauthenticated.",
  "exception_code": 0
}

Validation errors

{
  "message": "The given data was invalid.",
  "errors": {
    "first_name": [
      "The first name field is required."
    ],
    "phone_number": [
      "The phone number field must be a valid phone number."
    ]
  },
  "exception_code": 0
}

Not found errors

{
  "message": "The requested client could not be found.",
  "model": "client",
  "ids": [
    "client-300"
  ],
  "exception_code": 0
}

Status codes

The Cobrofácil API uses standard HTTP status codes. These are the most common responses your integration should handle.