v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB

Webhook - Cliente

Webhook - Criar/Atualizar

Pré-requisitos:

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. <br /> Fallback: Consultar pagamento por pagamentoId
Recebimento	Ocorre toda vez que uma transação é recebida na conta configurada (Notifica Recebimento e Restituição). <br /> Fallback: Recebimento - Consultar por parâmetros
DevolucaoEfetuada	Ocorre toda vez que uma Devolucao é realizada com sucesso. Notifica o status final da devolução. <br /> Fallback: Devolução - Consultar
PagamentoRetidoParaAnalise	Ocorre toda vez que um pagamento é retido para análise.
TokenBucketLimit	Ocorre quando verificado baixo nivel de Tokens do cliente.
FalhaPagamentoAsync	Ocorre quando uma Solicitaçao de Pagamento é solicitada com um PagamentoId já utilizado anteriormente
SolicitarComprovante	Ocorre quando um comprovante é solicitado

put/pix/direto/forintegration/v1/webhook/bs2

urlstring required

Url do cliente que receberá o evento quando disparado de acordo com a regra de negócio do evento.

Deve ser https.

eventosBs2PJPixCompartilhadosEnumsTipoEventoWebhook[] required

Webhook configurado com sucesso