Visão Geral
Uma implementação robusta da API FireBanking requer tratamento adequado de erros para garantir a melhor experiência do usuário e a confiabilidade do sistema. Este guia cobre os diferentes tipos de erro e as estratégias recomendadas para cada cenário.Códigos de Status HTTP
Respostas de Sucesso (2xx)
200 OK- Requisição processada com sucesso201 Created- Recurso criado com sucesso204 No Content- Operação bem-sucedida sem conteúdo de retorno
Erros do Cliente (4xx)
400 Bad Request- Dados inválidos na requisição401 Unauthorized- Credenciais de autenticação inválidas403 Forbidden- Acesso negado aos recursos404 Not Found- Recurso não encontrado422 Unprocessable Entity- Dados válidos mas regra de negócio violada429 Too Many Requests- Rate limit excedido
Erros do Servidor (5xx)
500 Internal Server Error- Erro interno do servidor502 Bad Gateway- Erro de gateway503 Service Unavailable- Serviço temporariamente indisponível504 Gateway Timeout- Timeout de gateway
Estrutura Padrão de Erro
Formato de Resposta
Campos Explicados
code: Código único do erro para tratamento programáticomessage: Mensagem em português para o usuário finaldetails: Informações adicionais sobre o erro (opcional)request_id: Identificador único da requisição para suportetimestamp: Momento em que o erro ocorreu
Tipos de Erro Comuns
Erros de Validação (400 Bad Request)
Dados Obrigatórios Ausentes
Dados Obrigatórios Ausentes
Formato Inválido
Formato Inválido
Erros de Autenticação (401/403)
API Key Inválida
API Key Inválida
IP Não Autorizado
IP Não Autorizado
Erros de Transação (422)
Erros de Cartão de Crédito
Cartão Recusado
Cartão Recusado
Limite Insuficiente
Limite Insuficiente
Token Expirado
Token Expirado
CVV Obrigatório
CVV Obrigatório
Transação Já Capturada
Transação Já Capturada
Erros de PIX
Chave PIX Inválida
Chave PIX Inválida
QR Code Expirado
QR Code Expirado
Valor Fora dos Limites PIX
Valor Fora dos Limites PIX
PIX Fora do Horário
PIX Fora do Horário
Erros de Boleto Bancário
Data de Vencimento Inválida
Data de Vencimento Inválida
Dados do Pagador Incompletos
Dados do Pagador Incompletos
Boleto Já Pago
Boleto Já Pago
Valor Abaixo do Mínimo
Valor Abaixo do Mínimo
Estratégias de Tratamento
1. Retry com Backoff Exponencial
Para erros temporários (5xx, timeouts):2. Circuit Breaker
Proteja sua aplicação de falhas consecutivas:3. Tratamento por Categoria de Erro
Tratamento de Webhooks com Falha
Retry Automático de Webhooks
A FireBanking implementa retry automático para webhooks falhados com backoff exponencial:- 1ª tentativa: Imediata
- 2ª tentativa: Após 30 segundos
- 3ª tentativa: Após 5 minutos
- 4ª tentativa: Após 30 minutos
- 5ª tentativa: Após 2 horas
Webhook de Falha Final
Quando todas as tentativas falharem, você receberá um webhook especial:Estratégias de Recuperação por Produto
PIX - Consulta de Status
Boleto - Verificação de Status
Cartão - Verificação de Autorizações
Implementação de Fallback
Monitoramento de Webhooks
Dashboard de Webhooks
- Taxa de entrega por produto
- Tempo médio de entrega
- Webhooks falhados por período
- URLs com maior taxa de falha
Alertas Automáticos
Logging e Monitoramento
Estrutura de Log Recomendada
Métricas de Monitoramento
Métricas Gerais
- Taxa de erro por tipo (4xx vs 5xx)
- Tempo de resposta por endpoint
- Rate limit atingido
- Tentativas de retry por transação
- Transações com falha por motivo
Métricas por Produto
PIX:- Taxa de QR Code expirado por período
- Chaves PIX inválidas por tentativa
- Tempo médio de confirmação de pagamento
- PIX fora de horário (manutenções)
- Taxa de abandono em QR Code
- Taxa de boletos cancelados vs emitidos
- Boletos vencidos não pagos por período
- Tempo médio entre emissão e pagamento
- Erros de dados do pagador por tipo
- Taxa de rejeição por valor mínimo
- Taxa de aprovação por bandeira
- Tokens expirados por tentativa
- Falhas de CVV por transação
- Tempo médio de autorização
- Taxa de chargeback por período
Dashboard Segregado
Recuperação de Transações
Estratégias de Recuperação por Produto
PIX - Recuperação Rápida
Para PIX, implemente consulta frequente devido à natureza instantânea:Boleto - Verificação Diária
Para boletos, implemente verificação diária e gestão de vencimentos:Cartão - Gestão de Autorizações
Para cartão, foque em autorizações pendentes e capturas:Recuperação Unificada
Implemente um sistema unificado de recuperação:Webhook de Recuperação
Configure webhook para receber atualizações perdidas:Dashboard de Erros
Monitore erros em tempo real através do Dashboard FireBanking:- Volume de erros por período
- Tipos de erro mais frequentes
- Transações com falha detalhadas
- Health check da API
Próximos Passos
Implementar Retry
Implemente as estratégias de retry por produto em sua aplicação
Configurar Monitoramento
Configure alertas e dashboards para erros críticos
Testar Cenários
Teste cenários de falha no ambiente de desenvolvimento
Configurar Webhooks
Configure webhooks e estratégias de recuperação
Guias por Método de Pagamento
Explore implementações específicas para cada método:🚀 PIX
Instantâneo • 24/7 • Taxa baixaTratamento de QR Code expirado, chaves inválidas
💳 Cartão de Crédito
Parcelamento • Tokens • 3DSGestão de autorizações, capturas, CVV
🏦 Boleto Bancário
Vencimentos • Multas • RenovaçãoReconciliação diária, boletos vencidos