Integração — Webhooks

Integração

Webhooks

Webhooks são a ponte assíncrona entre a plataforma e o seu sistema. Configure uma URL, escolha os eventos e mantenha tudo sincronizado sem polling.

Como funciona

Quando um evento acontece (pagamento confirmado, estorno realizado, payout liquidado), a plataforma faz um POST para a URL configurada na conta. Seu sistema responde com 2xx e o evento é dado como entregue.

  1. Configure o endpoint de webhook nas credenciais ou no console.
  2. Registre a URL e selecione os eventos desejados.
  3. Receba o POST com o payload do evento.
  4. Responda rapidamente com 2xx e processe o evento em background.

Principais eventos

EventoQuando dispara
charge issuedInstruções de pagamento emitidas (Pix/boleto)
charge paidPagamento confirmado
charge canceledCobrança cancelada
charge refundedEstorno concluído
charge chargebackChargeback aberto ou resolvido
payout issuedInstruções de payout emitidas
payout realizedPayout creditado ao beneficiário
payout returnedPayout devolvido
settlementMovimentação de saldo realizada

Confirmação de recebimento

Responda com status 2xx o mais rápido possível. Se não for possível, processe de forma assíncrona e confirme de imediato. A plataforma reenvia com backoff em caso de falha ou timeout.