Saltar al contenido principal
POST
curl
El endpoint de Didit para cancelar un Bank Link finaliza un enlace que la persona no ha completado, por lo que su url y su token dejan de funcionar. Úsalo cuando tu usuario abandone el flujo o cuando crees un enlace nuevo para el mismo usuario. Cancelar un enlace completado no cambia nada y responde 200 con el enlace sin modificar: para retirar el acceso, usa revocar.

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, desde Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener permisos limitados: ninguno, lectura o escritura por recurso, restringida a algunos flujos o solo a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, está revocada o ha caducado; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud procede de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, vídeos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Encabezados

Idempotency-Key
string

Clave opcional que eliges para garantizar la seguridad de los reintentos en una operación, de hasta 255 caracteres (puede usarse un UUID). Una solicitud repetida con la misma clave, endpoint, parámetros de consulta y cuerpo recibe la primera respuesta, con el mismo código de estado y el mismo cuerpo, y no se ejecuta ni se factura de nuevo. La misma clave con otro endpoint, otros parámetros de consulta o un cuerpo distinto devuelve 409 idempotency_key_reused. Si la primera solicitud sigue en curso, devuelve 409 idempotency_key_in_progress con Retry-After. Una solicitud fallida (cualquier 4xx o 5xx) no se almacena, así que puedes volver a enviarla con la misma clave. Las claves pertenecen a tu aplicación, tanto si llamas con una clave de API como con un token de acceso. Consulta Reintentos e idempotencia.

Required string length: 1 - 255

Parámetros de ruta

id
string<uuid>
requerido

El id del enlace.

Respuesta

El enlace, ahora cancelled, o sin cambios si ya estaba en un estado final.

Una ejecución de Bank Link para una persona: conectar un banco o renovar una conexión. Confirma tú mismo un enlace con get_link: nunca confíes en un id enviado por el navegador.

id
string<uuid>
requerido

Identificador del enlace.

mode
enum<string>
requerido
Opciones disponibles:
connect,
renew
access
enum<string>
requerido
Opciones disponibles:
one_time,
ongoing
status
enum<string>
requerido

Estado del enlace. completed, cancelled, expired y failed son estados finales.

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

La página alojada a la que hay que enviar a la persona. Se devuelve solo al crear el enlace; es null en las lecturas posteriores, porque el token no se almacena.

client_token
string | null
requerido

El token del Bank Link integrado de Didit, que todavía no está disponible: hoy, abre url. Se devuelve solo al crear el enlace; en lecturas posteriores es null. Tiene un único propósito y una vida corta. No contiene datos personales. No lo registres nunca en logs.

expires_at
string<date-time>
requerido

Cuándo deja de funcionar un enlace que no se ha canjeado.

connection_id
string<uuid> | null
requerido

La conexión que creó o renovó este enlace, una vez que status es completed.

check_id
string<uuid> | null
requerido

El resultado de propiedad de este enlace, cuando se solicitó ownership.compare distinto de none.

reused
boolean
requerido

true cuando el enlace se completó como una renovación de una conexión existente porque la persona ya comparte exactamente estas cuentas (duplicates: reuse). No se cobra dos veces.

error
object | null
requerido

Por qué falló el enlace, cuando status es failed. En caso contrario, null.

quote
object
requerido

El precio de un enlace, fijado al crearlo. El cargo es el de la cotización. Las lecturas nunca generan cargos.

vendor_data
string | null
requerido

Su referencia de la solicitud.

Última modificación el 22 de noviembre de 2026