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

# Webhooks bancários: eventos de ligação, conexão e dados

> Eventos webhook bank.link, bank.connection, bank.data e bank.sync da Didit: quando são enviados, o que incluem e como os usar na leitura diária.

Didit envia webhooks bancários quando uma ligação termina, quando uma conexão é alterada, quando o consentimento está prestes a expirar ou quando uma sincronização guarda novos dados.
Usam o mesmo envelope, assinatura e novas tentativas que todos os outros webhooks da Didit, e transportam apenas identificadores e estados: para ler o objeto, é preciso obtê-lo.

> [!NOTE]
>
> Os eventos de webhook bancários são enviados para aplicações em ambiente de produção e em sandbox.
> Escolha os eventos por destino com o filtro de eventos do destino, tal como para os outros eventos.
> Consulte [Webhooks](https://docs.didit.me/pt/integration/webhooks.md) para o envelope, os cabeçalhos de assinatura e as novas tentativas.

## Eventos

| Evento | Quando | Campos |
| - | - | - |
| `bank.link.completed` | A pessoa associou um banco. | `data.link_id`, `data.status`, `data.connection_id`, `data.check_id`, `data.error_code` (é sempre `null`) |
| `bank.link.cancelled` | A pessoa cancelou. | `data.link_id`, `data.status` |
| `bank.link.expired` | A ligação expirou antes de ser concluída. | `data.link_id`, `data.status` |
| `bank.link.failed` | A ligação terminou com um erro. | `data.link_id`, `data.status`, `data.error_code` |
| `bank.connection.created` | A primeira sincronização terminou e as contas já podem ser lidas. | `connection_id`, `initial_status` |
| `bank.connection.history_complete` | O preenchimento retroativo do histórico terminou, independentemente do motivo. | `connection_id`, `status` |
| `bank.connection.updated` | O estado, o consentimento ou o estado da sincronização foram alterados. | `connection_id`, `status`, `revocation_status` |
| `bank.connection.consent_expiring` | 14, 7 e 1 dia antes de o consentimento terminar. | `connection_id`, `days_left`, `consent_expires_at`, `renew_by` |
| `bank.connection.renewal_required` | O consentimento terminou, ou o banco pede à pessoa que volte a iniciar sessão. | `connection_id`, `status`, `reason`, `renew_by`, `renewable_until` |
| `bank.connection.renewed` | Uma ligação de renovação foi concluída. | `connection_id`, `status`, `consent_version`, `link_id`, `consent_expires_at` |
| `bank.connection.revoked` | O acesso terminou. | `connection_id`, `status`, `ended_by`, `status_reason`, `ended_at`, `retain_until` |
| `bank.connection.deleted` | A ligação e os respetivos dados foram eliminados. | `connection_id`, `status`, `erasure_status`, `reason`, `erased_at` |
| `bank.data.updated` | Uma sincronização guardou alterações. | `connection_id`, `sync_id`, `trigger`, `accounts` (ids com contagens), `balances_changed` |
| `bank.sync.completed` | Todas as sincronizações terminaram. | `connection_id`, `sync_id`, `trigger`, `outcome`, `changed` |
| `bank.sync.failed` | Uma sincronização continua a falhar. | `connection_id`, `sync_id`, `error_code`, `failing_since` |
| `bank.sync.recovered` | Uma sincronização que falhava voltou a funcionar. | `connection_id`, `sync_id` |

Todos os eventos incluem também os campos comuns `event_id`, `webhook_type`, `timestamp`, `created_at`, `application_id` e `environment`.
Os eventos `bank.link.*` incluem os respetivos campos em `data`; os eventos de ligação, de dados e de sincronização incluem-nos no nível superior.
`ended_by` assume um dos valores `end_user`, `bank`, `customer` ou `unknown`.
O esquema exato de cada evento está na [Referência da API](https://docs.didit.me/pt/standalone-apis/bank-data.md).

## Exemplo

```json theme={null}
{
  "event_id": "7c1e0a52-93d4-4a6b-8f21-0d5b9e3a64c7",
  "webhook_type": "bank.sync.completed",
  "timestamp": 1763804640,
  "created_at": 1763804640,
  "application_id": "b3e1f0a2-5d64-4c8e-9a17-2f6d0c8b7e41",
  "environment": "sandbox",
  "connection_id": "5e1d2a70-3b4c-4d5e-8f60-71829304a5b6",
  "sync_id": "c2b8d4f6-9a13-4e07-85bc-3d6e1f0a7b92",
  "trigger": "scheduled",
  "outcome": "succeeded",
  "changed": true
}
```

## Como utilizá-los

* **Novos dados.** `bank.data.updated` é apenas um sinal: nada é enviado. Chame o [fluxo de alterações](https://docs.didit.me/pt/standalone-apis/bank-transactions-sync.md) com o seu cursor guardado. Use `bank.sync.completed` apenas se quiser ver todas as sincronizações, incluindo as que não alteraram nada.
* **Onboarding.** Aguarde por `bank.connection.created` antes de ler as contas, e por `bank.connection.history_complete` antes de depender do histórico completo.
* **Consentimento.** Com `bank.connection.consent_expiring`, peça à pessoa que renove o consentimento. Com `bank.connection.renewal_required`, os dados continuam legíveis, mas deixam de ser sincronizados.
* **Parar.** Com `bank.connection.revoked`, pare o seu próprio fluxo para essa ligação e decida se quer [eliminar](https://docs.didit.me/pt/standalone-apis/bank-connection-delete.md) os dados guardados.
* **Duplicados.** Trate cada evento de forma idempotente: use o ID do evento como chave e esteja preparado para receber o mesmo evento duas vezes, de vez em quando.
* **Nunca confie no navegador.** Confirme uma ligação com `bank.link.completed` ou `GET /v3/bank/links/{id}/`, e não com um ID de ligação enviado por uma página.

## Próximos passos

* [Feed bancário contínuo para contabilidade](https://docs.didit.me/pt/use-cases/bank-data-for-accounting.md)
* [Sandbox](https://docs.didit.me/pt/core-technology/bank-verification/sandbox.md): o Didit Test Bank dispara estes eventos.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.