cursor pour les listes, page_token pour les lectures de transactions).
Les montants sont des chaînes décimales accompagnées d’un currency ISO 4217 séparé, les dates suivent la norme ISO 8601 et les pays sont codés en ISO alpha-3.
Les lectures ne sont jamais facturées.
Comptes
GET /v3/bank/connections/{id}/accounts/ liste les comptes d’une connexion, et GET /v3/bank/accounts/{account_id}/ en renvoie un seul.
Utilisez
account_ref pour reconnaître un compte bancaire lorsqu’une personne connecte à nouveau ce compte, et id pour tout ce qui concerne une même connexion.
Soldes
GET /v3/bank/accounts/{account_id}/balances/ renvoie les soldes typés, avec leurs dates de référence.
type vaut booked, available ou expected, et iso_type contient le code ISO 20022 de la banque lorsque celle-ci en fournit un.
Transactions
GET /v3/bank/accounts/{account_id}/transactions/ lit une plage de dates.
Il accepte date_from et date_to (dates calendaires telles que la banque les communique, bornes incluses), status (booked ou pending, les deux par défaut), limit (jusqu’à 500) et page_token.
Les résultats sont triés par effective_date décroissant, puis par id.
idest attribué par Didit au premier passage du mouvement. Le même mouvement conserve son id d’une lecture, d’une synchronisation ou d’un renouvellement à l’autre.identity_qualityindique la solidité de cette garantie.bank_referenceetroute_idsont stables.derivedsignifie que le mouvement a été rapproché sur son contenu : une correction de la banque peut donc apparaître sous la forme d’unremovedsuivi d’unadded.statusvautbookedoupending. Une transaction en attente a son propre id. Lorsque la banque la comptabilise, la transaction comptabilisée arrive enadded, et la transaction en attente enremovedavecreason: pending_booked.pending_idn’est renseigné que lorsque la banque les relie.amountest signé : un montant négatif correspond à une sortie d’argent.directionrépète ce signe.bank_referenceest la référence immuable de l’écriture donnée par la banque,nulllorsque la banque n’en fournit pas. Didit ne l’invente jamais.categoryest la catégorisation propre à Didit, lorsqu’elle s’applique.- Une correction de la banque sur une transaction comptabilisée est un
modified. Une annulation constitue une nouvelle transaction, accompagnée dereverses_idlorsque la banque la relie.
Les champs qu’une banque n’envoie pas valent null
Tout champ qu’une banque n’envoie pas vautnull.
L’institution liste les champs qu’elle transmet dans transaction_fields, ainsi que pending_transactions, pending_linkage, balance_types et history_days_max, afin que personne ne découvre des lacunes en production.
Utilisez le client de test sparse_fields dans le sandbox pour tester votre code avec une banque qui transmet peu de données.
Pagination d’une plage de dates
Continuez la lecture avecpage_token tant que has_more vaut true.
Le jeton fige l’instantané de la lecture pendant une heure : les ajouts survenus après la première page n’y figurent pas, chaque ligne est servie dans son état actuel, et une ligne supprimée pendant la pagination disparaît des pages suivantes et apparaît dans le flux de modifications.
Un jeton expiré renvoie 410 page_expired : relancez la lecture depuis sa requête d’origine.
Le flux des modifications
GET /v3/bank/connections/{id}/transactions/sync/ renvoie les modifications survenues sur l’ensemble des comptes d’une connexion depuis un cursor.
- Un curseur vide renvoie toutes les transactions actuelles sous la forme
addedavecreset: true. Remplacez votre copie par ces données au lieu de les ajouter. - Continuez à paginer avec
page_tokentant quehas_morevaut true. Enregistreznext_cursoruniquement après une réponse avechas_more: false. Si la pagination échoue en cours de route, repartez du curseur que vous avez enregistré. - Un curseur est opaque et lié à la connexion et à l’environnement. Le journal des modifications est rejouable pendant 90 jours. Un curseur plus ancien reçoit la réponse
410 cursor_expiredavecbootstrap: true: recommencez à partir d’un curseur vide et remplacez votre copie. removed[].reasonpeut valoirpending_booked,pending_expired,bank_removedouaccess_removed.
En-têtes
Les deux lectures de transactions renvoient les en-têtesX-RateLimit-* (600 lectures et 300 écritures par minute et par application, avec une réponse 429 et l’en-tête Retry-After au-delà de cette limite) ainsi que X-Bank-Last-Synced-At.
Les limites de l’API et les limites propres à la banque pour la récupération des données sont distinctes : consultez Actualiser les données bancaires à la demande.