Webhooks
Catálogo de eventos
Todos os tipos de evento da v1 e o escopo de leitura que cada um exige.
Página em construção
Este é um resumo. O conteúdo completo entra nas próximas versões da documentação; o contrato de cada rota já está na Referência da API.
| Evento | Quando | Escopo de leitura |
|---|---|---|
payment.succeeded | Pagamento confirmado | payments:<método>:read |
payment.failed | Pagamento recusado ou com erro | payments:<método>:read |
payment.refunded | Estorno concluído (data.refund traz o estorno) | payments:<método>:read |
chargeback.received | Chargeback aberto pelo portador | payments:<método>:read |
withdrawal.completed | Saque concluído | payouts:withdrawals:read |
withdrawal.failed | Saque falhou | payouts:withdrawals:read |
fx.operation.settled | Câmbio liquidado: dólar entregue na conta de destino | fx:operations:read |
fx.operation.expired | Câmbio expirado: Pix não pago no prazo | fx:operations:read |
fx.operation.failed | Câmbio falhou sem dinheiro recebido | fx:operations:read |
fx.operation.action_required | Pix recebido sem entrega; devolução aberta | fx:operations:read |
fx.operation.refunded | Valor do câmbio devolvido ao pagador | fx:operations:read |
settlement.closed | Liquidação fechada | receivables:settlements:read |
webhook_endpoint.disabled | Endpoint desativado por falhas | platform.core |
ping | Teste do endpoint (não é assinável) | platform.core |
data.object tem o mesmo formato do GET do recurso.