Clickfin

Referência da API
Portal oficial

Erros

Interprete validação, autenticação e falhas de negócio

As respostas de erro combinam código HTTP com categorias específicas do domínio. Essa estrutura ajuda a identificar rapidamente se a falha veio de validação, autenticação, autorização, regra de negócio ou erro interno.

Erros de validação

Quando a requisição falha nas regras de formato ou obrigatoriedade, a API costuma responder com 400 e error: VALIDATION_FAILED, acompanhado de detalhes por campo.

Autenticação e autorização

Falhas de credencial, token ausente, token expirado ou acesso sem permissão aparecem em códigos como 401 e 403, com category específica para facilitar o tratamento no cliente.

Como ler o campo category

  • Prefixos como AUTH.* indicam problemas ligados ao fluxo de autenticação.
  • Categorias de domínio apontam conflitos de regra de negócio, cadastro ou contexto operacional.
  • UNEXPECTED_ERROR representa falha interna inesperada e deve ser tratada como incidente de servidor.

Tratamento recomendado

  • Use o código HTTP para a decisão imediata do fluxo da interface.
  • Use category para mensagens mais precisas, logs e automações de suporte.
  • Registre também details quando houver erro de validação por campo.