> ## Documentation Index
> Fetch the complete documentation index at: https://docs-finance.superpagamentos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Como funcionam os webhooks da Super Finance

Todos os eventos da Super Finance são enviados por uma requisição para os endereços cadastrados no painel FINANCE. Assim você recebe cada atualização em tempo real, sem precisar ficar consultando a API.

## Configure seus webhooks

Ainda não configurou? No painel [FINANCE](https://finance.superpagamentos.basspago.com.br/), acesse a tela de configurações, na aba [WEBHOOKS](https://finance.superpagamentos.basspago.com.br/settings?tab=WEBHOOKS). Nela, você configura o recebimento de cinco tipos de webhook:

| Tipo                        | O que você recebe                                               |
| --------------------------- | --------------------------------------------------------------- |
| Transferências              | Todos os eventos relacionados a transferências.                 |
| Recebimento                 | Todos os eventos relacionados a pagamentos recebidos.           |
| Estorno                     | Todos os eventos relacionados a reembolsos de transações.       |
| Fila de saída de pagamentos | Eventos relacionados à fila de saída dos pagamentos.            |
| Infrações                   | Eventos relacionados às infrações (MEDs) abertas em transações. |

## Como configurar um webhook

Para configurar um webhook, clique no ícone de lápis <Icon icon="pencil" /> ao lado do tipo desejado. Um modal será aberto para você preencher:

<Steps>
  <Step title="URL de envio">
    O endereço HTTPS que receberá os eventos via POST.
  </Step>

  <Step title="E-mail para notificações de erros">
    E-mail avisado quando ocorrer um erro ao tentar enviar um webhook.
  </Step>

  <Step title="Pausar o envio dos webhooks">
    Controla se os eventos serão enviados.

    <Warning>
      Se essa opção ficar **ativa**, os webhooks **não** serão enviados. Deixe-a desativada para receber os eventos normalmente.
    </Warning>
  </Step>

  <Step title="Pausar o envio ao falhar">
    Pausa o envio de webhooks automaticamente quando um envio falhar. **Não recomendado**, pois pode interromper o recebimento de eventos seguintes.
  </Step>

  <Step title="Método de envio">
    O método HTTP usado para enviar o evento. Recomendamos **POST**.
  </Step>

  <Step title="Headers adicionais">
    Headers extras para os parâmetros de segurança interna da sua aplicação (por exemplo, um token de validação).
  </Step>
</Steps>

Após salvar, o seu webhook estará configurado.

## Gerencie seus webhooks

Ainda no painel, você pode:

* Pausar e retomar o envio dos webhooks.
* Editar a configuração de um webhook.
* Reenviar os webhooks de um período selecionado.

## Veja os eventos de webhooks

<CardGroup cols={3}>
  <Card title="Transações" icon="receipt" href="/api-reference/eventos-webhooks">
    Pagamentos recebidos e reembolsos.
  </Card>

  <Card title="Transferências" icon="money-bill-transfer" href="/api-reference/eventos-webhooks-cashout">
    Transferências realizadas e rejeitadas.
  </Card>

  <Card title="Contestações (MEDs)" icon="triangle-exclamation" href="/api-reference/eventos-webhooks">
    Infrações abertas em transações pagas.
  </Card>
</CardGroup>