Webhooks
O que são webhooks no FinWAY
Webhooks são notificações HTTP que a plataforma FinWAY envia ao endpoint do integrador
quando ocorrem eventos de domínio (ex.: criação/atualização de Pix, cobranças, conta, transações).
Permitem que o integrador reaja a eventos sem ficar consultando a API (polling). [INFERÊNCIA — canal de entrega]
Os domínios de evento documentados são: PIX, Charge, Account Holder, Transaction,
Individual Person, Company, Account e Product [FATO — catálogo de payloads].
Quando usar
- Para receber atualizações em tempo quase real de eventos (ex.: confirmação de recebimento de cobrança Pix).
- No fluxo de QR Code Dinâmico, o webhook é configurado para receber o evento de pagamento (ver QR Code Dinâmico, passos 3 e 10).
Onde encontrar os detalhes
- Referência completa de payloads por domínio: Referência de Webhooks.
- Visão geral de eventos e lacunas conhecidas: Eventos & Webhooks — Visão Geral.
- Endpoints de configuração de webhook (API): API Reference — Webhooks e Dynamic QR Code Webhooks.
observação
O conteúdo detalhado de payloads que antes vivia nesta página foi movido para a seção Dados & APIs → Eventos & Webhooks, mantendo esta página como guia de jornada.