Saltar al contingut principal
POST
curl
L’endpoint de Didit per cancel·lar un enllaç bancari finalitza un enllaç que la persona no ha completat, de manera que el seu url i el seu token deixen de funcionar. Utilitza’l quan el teu usuari abandona el flux o quan crees un enllaç nou per al mateix usuari. Cancel·lar un enllaç completat no canvia res i retorna 200 amb l’enllaç sense modificar: per revocar l’accés, usa revoke.

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'identificador de l'enllaç.

Resposta

L'enllaç, ara cancelled, o sense canvis si ja era definitiu.

Una execució de Bank Link per a una persona: connectar un banc o renovar una connexió. Confirma tu mateix un enllaç amb get_link: no confiïs mai en un identificador enviat pel navegador.

id
string<uuid>
requerit

Identificador de l'enllaç.

mode
enum<string>
requerit
Opcions disponibles:
connect,
renew
access
enum<string>
requerit
Opcions disponibles:
one_time,
ongoing
status
enum<string>
requerit

Estat de l'enllaç. completed, cancelled, expired i failed són estats finals.

Opcions disponibles:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
requerit

La pàgina allotjada a la qual cal enviar la persona. Només es retorna en crear l'enllaç; és null en lectures posteriors, perquè el token no s'emmagatzema.

client_token
string | null
requerit

El token del Bank Link integrat de Didit, que encara no està disponible: obre url avui. Només es retorna en crear l'enllaç; null en lectures posteriors. Té un únic propòsit i és de vida curta. No conté dades personals. No el registris mai.

expires_at
string<date-time>
requerit

Quan deixa de funcionar un enllaç no utilitzat.

connection_id
string<uuid> | null
requerit

La connexió que aquest enllaç ha creat o renovat, quan status és completed.

check_id
string<uuid> | null
requerit

El resultat de titularitat d'aquest enllaç, quan s'ha sol·licitat ownership.compare amb un valor diferent de none.

reused
boolean
requerit

true quan l'enllaç s'ha completat com a renovació d'una connexió existent perquè la persona ja comparteix exactament aquests comptes (duplicates: reuse). No es cobra res dues vegades.

error
object | null
requerit

Per què ha fallat l'enllaç, quan status és failed. En cas contrari, null.

quote
object
requerit

El preu d'un enllaç, fixat en el moment de crear-lo. El preu cobrat és el de la cotització. Les lectures no es facturen mai.

vendor_data
string | null
requerit

La vostra referència de la sol·licitud.

Darrera modificació el 22 de novembre del 2026