InícioReferência

Introdução

Módulo de WebhooksCopied!

Este módulo permite que você receba notificações automáticas sempre que alguns eventos acontecer no seu negócio. Ao configurar uma URL de Webhook, sua aplicação receberá informações em tempo real sobre os seguintes eventos:

  • Pix In Finalizado: Notificação de recebimento de um pagamento via Pix.

  • Pix Out Finalizado: Notificação de conclusão de um pagamento via Pix realizado.

  • Transação Cancelada: Notificação de cancelamento de uma transação.

Com isso, sua aplicação pode reagir instantaneamente a esses eventos, facilitando o gerenciamento de pagamentos e melhorando o controle de fluxos financeiros.

Como configurar um Webhook?Copied!

Siga os passos abaixo para configurar a URL de Webhook através do dashboard da FireBanking:

1. Faça login na FireBanking

  • Acesse o painel de administração da FireBanking através da URL: http://app.firebanking.io/.

  • Insira suas credenciais para realizar o login no sistema.

2. Acesse as Configurações

  • Uma vez logado, clique no ícone de engrenagem no canto superior direito da tela para acessar as configurações, ou simplesmente navegue até a URL: https://app.firebanking.io/settings.

3. Acesse a Aba de API e Webhook

  • No menu lateral esquerdo, localize e clique na aba API e Webhook.

  • Essa seção permite gerenciar suas credenciais de API e configurar URLs para receber notificações de Webhook.

Você deverá visualizar a mesma tela acima, no seu negócio.

4. Defina a URL do Webhook

  • No campo Webhook, insira a URL do endpoint da sua aplicação onde você deseja receber as notificações de transações.

  • Essa URL será utilizada para enviar atualizações sempre que uma transação for finalizada (Pix In ou Pix Out) ou cancelada.

5. Salve as Configurações

  • Após inserir a URL desejada, clique no botão Salvar para confirmar e ativar o Webhook.

O que esperar das notificações via Webhook?Copied!

A partir do momento que a URL de Webhook estiver configurada, você começará a receber notificações para os seguintes eventos:

  • Pix In Finalizado: Quando um pagamento via Pix for recebido com sucesso.

  • Pix Out Finalizado: Quando um pagamento via Pix realizado por sua aplicação for concluído.

  • Transação Cancelada: Quando uma transação for cancelada, seja pelo cliente ou por outro motivo.

Cada notificação enviada pelo Webhook conterá detalhes sobre a transação, como o valor, o ID da transação, status e timestamps.