Webhooks

Configurar webhook para receber situação do pagamento Pix e/ou Boleto.


🔗

A criação de webhooks é realizado na rota POST /v1/webhooks/

👍

Para exemplos de requisição e resposta da API, verifique a seção: Webhooks > Criar

Configurar Webhook

Os webhooks permitem que sua aplicação receba notificações automáticas sempre que ocorrer uma atualização em transações Pix e Boleto, como pagamentos aprovados, expirados e cancelados.

Com isso, não é necessário consultar a API constantemente para verificar mudanças de status.

Como funciona

  • Sua aplicação cria uma transação Pix ou Boleto.
  • A transação é processada pela plataforma.
  • Quando houver mudança de status, a API enviará uma requisição POST para a URL configurada.
  • Sua aplicação recebe o evento e atualiza o pedido internamente.

Requisitos

🚧
  • A URL deve utilizar HTTPS.
  • O endpoint deve aceitar requisições POST.
  • O servidor deve responder rapidamente (200 OK) .
  • O endpoint deve estar acessível publicamente.