Worldfy PaymentsWorldfy Payments
SuporteDashboard
GuiaAPI Reference
SuporteDashboard

Começando

IntroduçãoAutenticaçãoErrosPaginação e Filtros
Cobranças
Visão GeralMétodos de PagamentoCaptura e Estorno
Financeiro
RecebíveisAntecipaçõesCarteiras e ExtratosSaques
Configuração
Chaves de APIRecebedores
SDK de Segurança
Visão geralTokenizaçãoAutenticação 3DSAnálise de fraudeFluxo simplificadoFluxo completoErrosProdução e segurança
Webhooks
Visão GeralConfiguraçãoRetentativas
Eventos
Eventos de CobrançasEventos de Saques

Configuração

Como criar endpoints de webhook, gerenciar secrets e validar assinaturas HMAC-SHA256 para garantir a autenticidade das notificações.

Eventos de Cobranças

Lista completa de eventos de webhook relacionados a cobranças, com descrições e exemplos de payload.

Webhooks

Retentativas

Política de retentativas, backoff exponencial e boas práticas para garantir a entrega confiável de webhooks.

Política de retentativas

Se o seu servidor não responder com um status HTTP 2xx, a Worldfy reenvia a notificação automaticamente com backoff exponencial.

TentativaAtrasoTempo acumulado
1a30 segundos30s
2a1 minuto1min 30s
3a5 minutos6min 30s
4a15 minutos21min 30s
5a30 minutos51min 30s
6a1 hora1h 51min
7a2 horas3h 51min
8a4 horas7h 51min
9a8 horas15h 51min
10a24 horas~40h

Após 10 tentativas sem sucesso, a entrega é marcada como exhausted (esgotada) e não será mais reenviada. O ciclo completo de retentativas cobre aproximadamente 40 horas.

Status de entrega

StatusDescrição
pendingEntrega pendente (aguardando envio)
successEntregue com sucesso (resposta 2xx)
failedFalha na entrega (será retentada)
exhaustedTodas as tentativas esgotadas

Consultando entregas

Você pode auditar as entregas dos seus webhooks pelos logs de entrega:

curl -X GET "https://api.worldfypayments.com/v1/postbacks/delivery-logs?status=failed&page=1&limit=20" \
  -H "Authorization: Basic {credentials}"
ParâmetroTipoDescrição
statusstringpending, success, failed ou exhausted
event_namestringFiltra por nome do evento (ex: charge.captured)
pagenumberPágina (padrão 1)
limitnumberItens por página (padrão 20)

Cada log inclui status, attempt, max_attempts, response_status_code, error_message, next_retry_at e delivered_at, entre outros campos.

Reenviando manualmente

Uma entrega pode ser reenviada manualmente a qualquer momento:

curl -X POST https://api.worldfypayments.com/v1/postbacks/delivery-logs/{id}/resend \
  -H "Authorization: Basic {credentials}"

Resposta esperada

Sua aplicação deve:

  • Responder com status HTTP 2xx (200, 201, 202, etc.)
  • Responder em até 10 segundos — após esse tempo, a requisição é abortada e a tentativa marcada como falha
  • Retornar o mais rápido possível

Não processe a lógica de negócios antes de responder ao webhook. Responda 200 OK imediatamente e processe o evento de forma assíncrona.

Boas práticas

Idempotência

O mesmo evento pode ser entregue mais de uma vez (em caso de timeout ou falha de rede). Use o campo id do payload como chave de idempotência para evitar processamento duplicado.

Tempo de resposta

Mantenha o tempo de resposta abaixo de 5 segundos. Se o processamento do evento é demorado:

  1. Salve o evento em uma fila ou banco de dados
  2. Responda 200 OK imediatamente
  3. Processe o evento em background

Verificação de assinatura

Sempre valide a assinatura HMAC antes de processar qualquer evento. Isso garante que a notificação veio da Worldfy e não foi adulterada.

Monitoramento

Monitore falhas de entrega. Se muitas notificações estão falhando, verifique:

  • Se a URL está acessível publicamente
  • Se o certificado SSL é válido
  • Se o servidor responde em menos de 10 segundos
  • Se o firewall permite conexões da Worldfy

Configuração

Como criar endpoints de webhook, gerenciar secrets e validar assinaturas HMAC-SHA256 para garantir a autenticidade das notificações.

Eventos de Cobranças

Lista completa de eventos de webhook relacionados a cobranças, com descrições e exemplos de payload.

On this page

Política de retentativasStatus de entregaConsultando entregasReenviando manualmenteResposta esperadaBoas práticasIdempotênciaTempo de respostaVerificação de assinaturaMonitoramento