Saltar al contingut principal
POST
curl
L’endpoint de Didit per revocar una connexió bancària atura l’accés al banc, i les consultes al banc s’aturen tan bon punt ho sol·licites. Revocar no elimina res: per a això, fes servir eliminar. El consentiment mostra revocation_pending i, després, revoked quan el banc ho confirma.

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau principal té accés complet. Una clau amb nom es pot limitar: cap, lectura o escriptura per recurs, limitada a alguns fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 vol dir que la clau és incorrecta, revocada o caducada; 403 vol dir que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud ve d'una adreça fora de la seva llista d'adreces IP; 404 en una ruta de sessió vol dir que la sessió queda fora dels fluxos de treball o estats de la clau. Una clau sense accés a multimèdia rep les URL d'imatges, vídeos i PDF com a null, i una clau sense escriptura de sessions rep els enllaços i els tokens de sessió com a null. Vegeu https://docs.didit.me/console/api-keys.

Capçaleres

Idempotency-Key
string

Clau opcional de seguretat per a reintents que tu tries per a una operació, de fins a 255 caràcters (un UUID funciona). Una sol·licitud repetida amb la mateixa clau, endpoint, consulta i cos rep la primera resposta, amb el mateix codi d'estat i el mateix cos, i no s'executa ni es factura una segona vegada. La mateixa clau amb un altre endpoint, consulta o cos retorna 409 idempotency_key_reused, i mentre la primera sol·licitud encara s'està processant, 409 idempotency_key_in_progress amb Retry-After. Una sol·licitud fallida (qualsevol 4xx o 5xx) no s'emmagatzema, de manera que pots tornar-la a enviar amb la mateixa clau. Les claus pertanyen a la teva aplicació, tant si crides amb una clau d'API com amb un token d'accés. Consulta Reintents i idempotència.

Required string length: 1 - 255

Paràmetres de ruta

id
string<uuid>
requerit

L'id de la connexió.

Resposta

La connexió amb l'estat de revocació.

El permís de la persona perquè la teva aplicació llegeixi un banc. Una renovació manté l'id de la connexió i tots els ids de compte. Una connexió eliminada només respon amb id, status, status_reason, created_at i erasure: la resta de camps no hi són, i no hi queda cap dada del banc, de la persona ni del compte.

id
string<uuid>
requerit

Identificador de la connexió.

status
enum<string>
requerit

pending: la primera sincronització s'està executant. active: consentiment vàlid. renewal_required: el consentiment ha finalitzat o el banc vol que la persona torni a iniciar sessió; les dades es poden llegir tal com es van sincronitzar per última vegada i no es factura res. paused: saldo insuficient per al mes. revoked: accés aturat per la persona, pel banc o per vosaltres. deleted: només queden id, status, status_reason, created_at i erasure. failed: la primera sincronització mai no ha reeixit.

Opcions disponibles:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
requerit

Per què la connexió té aquest estat. paused_by_customer està reservat. En una connexió deleted: deleted_by_customer, consent_lapsed, retention_elapsed o application_deleted.

Opcions disponibles:
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,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
requerit

S'estableix després de delete_connection; en cas contrari, null.

created_at
string<date-time>
requerit
environment
enum<string>
Opcions disponibles:
live,
sandbox
access
enum<string>
Opcions disponibles:
one_time,
ongoing
institution
object

El banc al qual pertany una connexió o un enllaç.

segment
enum<string> | null
Opcions disponibles:
personal,
business,
null
data
enum<string>[]

Els àmbits que la persona ha acceptat.

Opcions disponibles:
accounts,
balances,
transactions

El consentiment de la persona per a aquesta connexió.

sync
object

Estat de sincronització d'una connexió.

accounts
object[]

Resum de cada compte de la connexió. Llegeix el compte complet amb get_account.

ownership
object

La comparació opcional del titular del compte amb una persona o una empresa.

end_user
object
manage_url
string<uri> | null

La pàgina d'accés pròpia de la persona. null fins que la pàgina d'accés estigui disponible.

billing
object

Quant costa aquesta connexió. El sandbox no es cobra mai.

possible_duplicate_of
string<uuid> | null

S'estableix quan aquesta connexió pot duplicar una altra d'activa, però cap end_user.reference no ha permès una coincidència determinada.

vendor_data
string | null
updated_at
string<date-time>
Darrera modificació el 22 de novembre del 2026