Pular para o conteúdo principal
Uma conexão bancária da Didit é a permissão de uma pessoa ou empresa para que sua aplicação leia um banco, com as datas de consentimento, o estado de sincronização e as contas desse banco. Uma Bank Link concluída cria a conexão, que permanece válida pelo tempo que o banco e a pessoa permitirem. Os dados bancários estão disponíveis para aplicações em sandbox; as chamadas de uma aplicação em produção retornam 404 até que o acesso em produção seja anunciado.

Acesso único e contínuo

O acesso contínuo só funciona em bancos que o permitem. Consulte o endpoint de instituições ou leia a página de cobertura. Quando um banco não consegue manter o acesso aberto, a pessoa é informada de que o banco não permite acesso contínuo e precisa escolher outro banco. Defina allow_one_time_fallback: true para que a pessoa continue com uma leitura única depois de confirmar o acesso reduzido na própria tela: a conexão fica então como one_time.

Status

status_reason é um dos seguintes valores: collection_complete, consent_expired, consent_lapsed, bank_requires_sign_in, revoked_by_end_user, revoked_by_bank, revoked_by_customer, insufficient_balance, paused_by_customer (reservado, nenhum endpoint o define atualmente) e first_sync_failed.

Consentimento

O banco define o fim do consentimento, até o consent_days que você solicitou. Cada conexão mostra suas datas reais em consent:
  • expires_at e renew_by: o fim do consentimento. Renove antes dele para não ter interrupção.
  • renewable_until: o último momento em que a mesma conexão pode ser reativada depois que o consentimento terminou.
  • renewed_count, version, scopes_granted e accounts_granted: o que foi concedido e quantas vezes ele foi renovado.
O consentimento dura pelo tempo que o banco permitir. Consulte o valor real em cada conexão e o valor por banco na instituição.

Renovação

Uma renovação mantém o id da conexão e todos os ids de conta, e o histórico continua sem duplicatas.
  1. A Didit envia bank.connection.consent_expiring 14, 7 e 1 dia antes do fim.
  2. Chame POST /v3/bank/connections/{id}/renew/. Ele responde 409 renewal_not_needed enquanto restarem mais de 30 dias e 409 renewal_window_expired após consent.renewable_until. Caso contrário, responde 201 com um link de renovação.
A página em que a pessoa conclui a renovação ainda não está disponível, então não envie as pessoas para um link de renovação por enquanto. Se a pessoa deixar o consentimento expirar, a conexão passa para renewal_required: os dados permanecem acessíveis como estavam na última sincronização e nada é cobrado. Após consent.renewable_until, ela passa para revoked com status_reason: consent_lapsed, e a pessoa se conecta novamente. Para o fluxo completo, veja Renovar um consentimento bancário.

Interromper o acesso

Interromper o acesso não é excluir. Leia Dados, consentimento e exclusão para saber exatamente o que a exclusão remove.

Uma conexão excluída

Uma conexão excluída responde apenas id, status (deleted), status_reason, created_at e erasure. status_reason é deleted_by_customer, consent_lapsed, retention_elapsed ou application_deleted. Todos os outros campos estão ausentes.

Duplicados

Um novo link que resolve exatamente para as contas que você já compartilha com o mesmo end_user.reference no mesmo banco é concluído como uma renovação dessa conexão (reused: true) e não cobra duas vezes. Qualquer outra sobreposição encerra o link com failed, duplicate_conflict e conflicts_with, antes que qualquer coisa seja armazenada ou cobrada. Renove a conexão existente ou crie o link novamente com "duplicates": "allow" para uma segunda conexão independente.

Gerencie as conexões dos seus clientes

  • Listagem com filtros: GET /v3/bank/connections/ aceita status, access, institution_id, country, vendor_data, end_user_reference, consent_expires_before e created_after.
  • Veja quanto custa cada conexão com o objeto billing: a unidade, o preço e o mês já liquidado.
Última modificação em 22 de novembro de 2026