Skip to main content

Exemplos Completos


Idempotência

Webhooks podem ser enviados mais de uma vez (em caso de retentativas). Implemente tratamento de idempotência para evitar processamento duplicado.
Use o campo transactionId como chave única:
  • Performance: Verificação em memória é extremamente rápida
  • Distribuído: Funciona com múltiplas instâncias do servidor
  • TTL automático: Limpeza automática de registros antigos

Boas Práticas

O sistema espera resposta em até 10 segundos. Responda imediatamente e processe de forma assíncrona para evitar timeouts.
Configure seu endpoint apenas com HTTPS para garantir transmissão segura.
Sempre valide o header Authorization com Basic Auth.
O campo externalId contém o identificador enviado na criação. Use-o para correlacionar com seus registros.

Retentativas

Se seu endpoint não responder com HTTP 200 em até 10 segundos:
Após 4 tentativas sem sucesso (tempo total ~25 minutos), o webhook é movido para uma fila de falhas (DLQ). Implemente consulta periódica como fallback para garantir que nenhuma transação seja perdida.
A estratégia de retry diferencia erros temporários (network, timeout, 5xx) de erros permanentes (validação, formato inválido). Erros permanentes não são retentados.

Códigos de Resposta

Seu endpoint deve retornar um código HTTP apropriado:
O sistema valida apenas o código HTTP. Qualquer resposta 2xx (200-299) é considerada sucesso, independente do conteúdo do body. Você pode retornar body vazio, "OK", ou qualquer JSON.

Próximos Passos

PIX Cash-In

Aprenda a gerar cobranças PIX

PIX Cash-Out

Aprenda a enviar pagamentos PIX

Estornar Pagamento

Aprenda a estornar recebimentos

Autenticação

Configure a autenticação da API