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.
- Configure o endpoint de webhook nas credenciais ou no console.
- Registre a URL e selecione os eventos desejados.
- Receba o POST com o payload do evento.
- Responda rapidamente com 2xx e processe o evento em background.
Principais eventos
| Evento | Quando dispara |
|---|---|
| charge issued | Instruções de pagamento emitidas (Pix/boleto) |
| charge paid | Pagamento confirmado |
| charge canceled | Cobrança cancelada |
| charge refunded | Estorno concluído |
| charge chargeback | Chargeback aberto ou resolvido |
| payout issued | Instruções de payout emitidas |
| payout realized | Payout creditado ao beneficiário |
| payout returned | Payout devolvido |
| settlement | Movimentaçã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.