Passer au contenu principal
POST
curl
L’endpoint Cancel a Bank Link de Didit met fin à un lien bancaire que la personne n’a pas terminé, de sorte que son url et son token ne fonctionnent plus. Utilisez-le lorsque votre utilisateur abandonne le parcours ou lorsque vous créez un nouveau lien pour le même utilisateur. L’annulation d’un lien terminé ne modifie rien et renvoie 200 avec le lien inchangé : pour couper l’accès, utilisez plutôt révoquer.

Autorisations

x-api-key
string
header
requis

La clé API de votre application, disponible dans Developers -> API keys de la Business Console. La clé principale a un accès complet. Une clé nommée peut être limitée : aucun accès, lecture ou écriture par ressource, restreinte à certains workflows ou à certaines sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou à cette action, ou que la requête provient d'une adresse hors de sa liste d'adresses IP ; 404 sur une route de session signifie que la session se trouve hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL des images, vidéos et PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

En-têtes

Idempotency-Key
string

Clé facultative de sécurisation des nouvelles tentatives, que vous choisissez pour une opération, d'au plus 255 caractères (un UUID convient). Une requête répétée avec la même clé, le même endpoint, les mêmes paramètres de requête et le même corps reçoit la première réponse, avec le même statut et le même corps, et n'est ni exécutée ni facturée une seconde fois. La même clé avec un autre endpoint, d'autres paramètres de requête ou un autre corps renvoie 409 idempotency_key_reused. Tant que la première requête est encore en cours, elle renvoie 409 idempotency_key_in_progress avec Retry-After. Une requête échouée (tout 4xx ou 5xx) n'est pas enregistrée, vous pouvez donc la renvoyer avec la même clé. Les clés sont propres à votre application, que vous appeliez avec une clé API ou un jeton d'accès. Voir Nouvelles tentatives et idempotence.

Required string length: 1 - 255

Paramètres de chemin

id
string<uuid>
requis

L'identifiant du lien.

Réponse

Le lien, désormais cancelled, ou inchangé s'il était déjà définitif.

Une exécution de Bank Link pour une personne : connecter une banque ou renouveler une connexion. Confirmez vous-même un lien avec get_link : ne faites jamais confiance à un identifiant envoyé par le navigateur.

id
string<uuid>
requis

Identifiant du lien.

mode
enum<string>
requis
Options disponibles:
connect,
renew
access
enum<string>
requis
Options disponibles:
one_time,
ongoing
status
enum<string>
requis

Statut du lien. completed, cancelled, expired et failed sont des statuts définitifs.

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

La page hébergée vers laquelle orienter la personne. Renvoyée uniquement à la création du lien ; null lors des lectures ultérieures, car le token n'est pas stocké.

client_token
string | null
requis

Le jeton du Bank Link intégré de Didit, qui n'est pas encore disponible : ouvrez url dès aujourd'hui. Renvoyé uniquement à la création du lien ; null lors des lectures suivantes. Usage unique et de courte durée. Il ne contient aucune donnée personnelle. Ne le journalisez jamais.

expires_at
string<date-time>
requis

Quand un lien non utilisé cesse de fonctionner.

connection_id
string<uuid> | null
requis

La connexion créée ou renouvelée par ce lien, une fois que status vaut completed.

check_id
string<uuid> | null
requis

Le résultat de la comparaison de l'actionnariat de ce lien, lorsque ownership.compare a été demandé avec une valeur autre que none.

reused
boolean
requis

true lorsque le lien a été finalisé comme un renouvellement d'une connexion existante, car la personne partage déjà exactement ces comptes (duplicates: reuse). Aucun montant n'est facturé deux fois.

error
object | null
requis

Pourquoi le lien a échoué, lorsque status vaut failed. Sinon null.

quote
object
requis

Le prix d'un lien, figé à sa création. Le montant facturé est celui du devis. Les lectures ne sont jamais facturées.

vendor_data
string | null
requis

Votre référence issue de la requête.

Dernière modification le 22 novembre 2026