Status de transações (PIX IN)
Estados do ciclo de vida
| Status | Descrição | Tempo Típico | Próxima Ação |
|---|---|---|---|
pending | Aguardando pagamento | 0-12 horas | Mostrar QR Code para cliente |
paid | Pago com sucesso | Instantâneo | Liberar produto/serviço |
canceled | Cancelado | Manual | Gerar novo QR Code se necessário |
refunded | Estornado | 1-3 dias úteis | Valor devolvido ao pagador |
expired | Expirado | 12 horas | Gerar nova cobrança |
Fluxo visual
Detalhes por status
pending - Aguardando pagamento
pending - Aguardando pagamento
Quando ocorre: QR Code foi gerado com sucesso
Duração: Até 12 horas ou até ser pago
Webhook:
Duração: Até 12 horas ou até ser pago
Webhook:
transaction_createdAções recomendadas:- Exibir QR Code para o cliente
- Iniciar polling de status ou aguardar webhook
- Mostrar contador de tempo para expiração
paid - Pago com sucesso
paid - Pago com sucesso
Quando ocorre: PIX foi recebido e confirmado
Duração: Permanente
Webhook:
Duração: Permanente
Webhook:
transaction_paidAções recomendadas:- Liberar produto ou serviço imediatamente
- Enviar email de confirmação
- Atualizar estoque
- Iniciar processo de entrega
canceled - Cancelado
canceled - Cancelado
Quando ocorre: Cancelamento manual ou automático
Duração: Permanente
Webhook:
Duração: Permanente
Webhook:
transaction_canceledAções recomendadas:- Informar cliente sobre cancelamento
- Gerar novo QR Code se necessário
- Limpar carrinho ou sessão
refunded - Estornado
refunded - Estornado
Quando ocorre: Estorno processado com sucesso
Duração: Permanente
Webhook:
Duração: Permanente
Webhook:
transaction_refundedAções recomendadas:- Cancelar entrega se ainda não enviada
- Restaurar estoque
- Notificar cliente sobre estorno
- Atualizar sistemas financeiros
Status de transferências (PIX OUT)
Estados do ciclo de vida
| Status | Descrição | Tempo Típico | Próxima Ação |
|---|---|---|---|
created | Criada e validada | Instantâneo | Aguardar processamento |
processing | Em processamento | 1-10 segundos | Aguardar conclusão |
completed | Concluída com sucesso | 3-15 segundos | Transferência realizada |
canceled | Cancelada pelo sistema | 5-30 segundos | Verificar motivo |
refused | Recusada pela instituição | 10-60 segundos | Verificar dados |
Fluxo visual
Detalhes por status
created - Criada e validada
created - Criada e validada
Quando ocorre: Transferência foi aceita e validada
Duração: 1-3 segundos
Webhook:
Duração: 1-3 segundos
Webhook:
transfer_createdCaracterísticas:- Dados validados com sucesso
- Saldo verificado e reservado
- Chave PIX validada
processing - Em processamento
processing - Em processamento
Quando ocorre: Transferência sendo processada pelo sistema
Duração: 3-10 segundos
Webhook:
Duração: 3-10 segundos
Webhook:
transfer_updatedCaracterísticas:- Comunicação com o SPI (Sistema de Pagamentos Instantâneos)
- Verificação final de dados
- Processamento da transferência
completed - Concluída
completed - Concluída
Quando ocorre: Transferência PIX concluída com sucesso
Duração: Permanente
Webhook:
Duração: Permanente
Webhook:
transfer_completedCaracterísticas:- Dinheiro transferido com sucesso
- End-to-End ID gerado
- Comprovante disponível
refused - Recusada
refused - Recusada
Quando ocorre: Transferência recusada pela instituição
Duração: Permanente
Webhook:
Duração: Permanente
Webhook:
transfer_refusedMotivos comuns:- Chave PIX não encontrada
- Conta de destino inativa
- Limites de recebimento excedidos
- Problemas técnicos temporários
❌ Códigos de Erro HTTP
Códigos de Sucesso (2xx)
| Código | Descrição | Uso Comum |
|---|---|---|
200 | OK | Operação bem-sucedida |
201 | Created | Recurso criado com sucesso |
204 | No Content | Operação bem-sucedida sem conteúdo |
Códigos de Erro do Cliente (4xx)
| Código | Erro | Descrição | Solução |
|---|---|---|---|
400 | Bad Request | Dados inválidos na requisição | Verificar formato dos dados |
401 | Unauthorized | Token inválido ou ausente | Renovar token de acesso |
403 | Forbidden | Sem permissão para a operação | Verificar permissões da API Key |
404 | Not Found | Recurso não encontrado | Verificar ID do recurso |
409 | Conflict | Conflito na operação | Verificar estado do recurso |
422 | Unprocessable Entity | Dados não processáveis | Verificar regras de negócio |
429 | Too Many Requests | Rate limit excedido | Aguardar e tentar novamente |
Códigos de Erro do Servidor (5xx)
| Código | Erro | Descrição | Solução |
|---|---|---|---|
500 | Internal Server Error | Erro interno do servidor | Tentar novamente ou contatar suporte |
502 | Bad Gateway | Erro de gateway | Aguardar alguns minutos |
503 | Service Unavailable | Serviço temporariamente indisponível | Aguardar e tentar novamente |
504 | Gateway Timeout | Timeout no gateway | Tentar novamente |
Códigos de erro específicos
Erros de Autenticação
| Código | Mensagem | Causa | Solução |
|---|---|---|---|
AUTH_001 | Token expirado | Token JWT expirou | Gerar novo token |
AUTH_002 | Token inválido | Token malformado | Verificar formato do token |
AUTH_003 | Credenciais inválidas | API Key/Secret incorretos | Verificar credenciais |
AUTH_004 | Acesso negado | Sem permissão | Verificar escopo da API Key |
Erros de PIX IN
| Código | Mensagem | Causa | Solução |
|---|---|---|---|
PIX_IN_001 | Valor inválido | Valor fora dos limites | Verificar valor mín/máx |
PIX_IN_002 | CPF/CNPJ inválido | Documento malformado | Validar documento |
PIX_IN_003 | Email inválido | Formato de email incorreto | Verificar email |
PIX_IN_004 | QR Code expirado | Tentativa de uso após expiração | Gerar novo QR Code |
Erros de PIX OUT
| Código | Mensagem | Causa | Solução |
|---|---|---|---|
PIX_OUT_001 | Saldo insuficiente | Não há saldo na conta | Verificar saldo |
PIX_OUT_002 | Chave PIX inválida | Formato da chave incorreto | Validar chave PIX |
PIX_OUT_003 | Limite diário excedido | Limite de transferências atingido | Aguardar próximo dia |
PIX_OUT_004 | Destinatário indisponível | Chave PIX não encontrada | Verificar chave PIX |
Erros de Webhook
| Código | Mensagem | Causa | Solução |
|---|---|---|---|
WEBHOOK_001 | URL inválida | Formato incorreto da URL | Verificar URL |
WEBHOOK_002 | URL não acessível | Endpoint não responde | Verificar conectividade |
WEBHOOK_003 | Evento inválido | Evento não existe | Usar eventos válidos |
WEBHOOK_004 | Limite excedido | Muitos webhooks configurados | Remover webhooks antigos |
Estrutura de resposta de erro
Formato Padrão
Campos da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
success | boolean | Sempre false para erros |
error.code | string | Código específico do erro |
error.message | string | Mensagem descritiva do erro |
error.field | string | Campo que causou o erro (opcional) |
error.details | object | Informações adicionais (opcional) |
timestamp | string | Data/hora do erro |
requestId | string | ID único da requisição |