Passer au contenu principal
POST
curl
L’endpoint Refresh a Bank Connection de Didit demande une synchronisation immédiate et répond 202 avec le sync_id. Envoyez "wait": true pour patienter jusqu’à 25 secondes et obtenir la synchronisation terminée en un seul appel, sans frais supplémentaires. La banque limite l’accès non supervisé : l’appel peut donc répondre 429 refresh_limit_reached avec Retry-After. Voir Actualiser les données bancaires à la demande.

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
Prefer
string

wait=<seconds> maintient l'appel jusqu'à ce nombre de secondes, au maximum 25, comme wait: true dans le corps de la requête.

Exemple:

"wait=25"

Paramètres de chemin

id
string<uuid>
requis

L'identifiant de la connexion.

Corps

application/json

Corps facultatif d'une actualisation.

wait
boolean
défaut:false

true maintient l'appel jusqu'à 25 secondes et répond 200 avec la synchronisation terminée, de sorte qu'une seule requête renvoie des données à jour. Si la banque n'a pas répondu dans ce délai, l'appel répond 202 : lisez la synchronisation avec get_sync_run en utilisant le sync_id, ou abonnez-vous à bank.sync.completed. bank.data.updated n'est envoyé que si la synchronisation enregistre des modifications. L'en-tête Prefer: wait=<seconds> (jusqu'à 25) produit le même effet.

Réponse

La synchronisation s'est terminée dans les 25 secondes.

Une synchronisation terminée renvoyée par une actualisation avec wait : l'exécution de synchronisation avec son outcome, les décomptes par compte dans results et balances_changed.

id
string<uuid>
requis
connection_id
string<uuid>
requis
trigger
enum<string>
requis
Options disponibles:
initial,
scheduled,
requested
status
enum<string>
requis
Options disponibles:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
requis
finished_at
string<date-time> | null
requis
results
object[]
requis

Ce que l'exécution a fait, par compte et par ressource.

error
object | null
requis

Pourquoi l'exécution a échoué dans son ensemble. null si ce n'est pas le cas. Les erreurs liées aux comptes et aux ressources pris individuellement figurent dans results.

outcome
enum<string>
requis

Résultat de la synchronisation.

Options disponibles:
succeeded,
partial,
failed
balances_changed
boolean
requis

Si un solde a changé.

Dernière modification le 22 novembre 2026