Logo

Erros

Formato das respostas de erro e os códigos de status retornados pela API.

Quando uma requisição falha, a API responde com o código HTTP correspondente e um corpo JSON padronizado.

Formato do erro

{
  "error": "Bad Request",
  "message": "Descrição do que deu errado",
  "status_code": 400
}

Prop

Type

Códigos de status

StatusSignificadoQuando ocorre
400Bad RequestParâmetros inválidos ou ausentes (falha de validação)
401UnauthorizedToken ausente, malformado ou inválido
404Not FoundRecurso não encontrado (ex.: pix_id inexistente)
500Internal Server ErrorErro inesperado no servidor

Os endpoints de cada recurso listam os códigos específicos que podem retornar. Consulte a página do endpoint para detalhes.

Erros de validação

Requisições com corpo ou parâmetros inválidos retornam 400 com error: "Bad Request" e uma message descrevendo o campo que falhou:

{
  "error": "Bad Request",
  "message": "An instance of CreatePaymentRequest has failed the following validations: ...",
  "status_code": 400
}

Erro de autenticação

Requisições sem um token válido retornam 401:

{
  "error": "Unauthorized",
  "message": "Não autenticado",
  "status_code": 401
}

Revise o cabeçalho Authorization conforme a página de Autenticação.

On this page