put https://example.com/pix/direto/forintegration/v1/webhook/bs2
Pré-requisitos:
- Uma rota acessível na internet para receber os eventos de webhook.
Características:
- Realiza uma chamada para a rota configurada de acordo com a realização do evento parametrizado.
- Pode ser usado como mecanismo de conciliação.
- Deve ser usado em conjunto à algum mecanismo de callback para conciliação referente ao evento configurado.
- O disparo do webhook só começa a ocorrer após o cadastro do certificado do DNS da rota parametrizada. Webhook - Certificado - Inclusão/Atualização
Eventos configuráveis para webhook
| Evento | Descrição |
|---|---|
| Pagamento | Ocorre toda vez que um Pagamento Pix é realizado com sucesso. Notifica o status final do pagamento. Fallback: Consultar pagamento por pagamentoId |
| Recebimento | Ocorre toda vez que uma transação é recebida na conta configurada (Notifica Recebimento e Restituição). Fallback: Recebimento - Consultar por parâmetros |
| DevolucaoEfetuada | Ocorre toda vez que uma Devolucao é realizada com sucesso. Notifica o status final da devolução. Fallback: Devolução - Consultar |
| ValidacaoChaves | Ocorre toda vez que uma checagem de validação de chaves é realizada com sucesso. Notifica a validez de uma chave. Fallback: Solicitação de validação de chaves |
| SolicitarComprovante | Ocorre quando um comprovante é solicitado |
| FalhaPagamentoAsync | Ocorre quando uma Solicitaçao de Pagamento é solicitada com um PagamentoId já utilizado anteriormente |