cursor bei Listen, page_token bei den Transaktionsabfragen).
Beträge sind Dezimalzeichenketten mit einem separaten currency-Feld nach ISO 4217, Datumsangaben folgen ISO 8601, und Länder werden nach ISO alpha-3 angegeben.
Lesezugriffe werden nie abgerechnet.
Konten
GET /v3/bank/connections/{id}/accounts/ listet die Konten einer Verbindung auf, und GET /v3/bank/accounts/{account_id}/ gibt ein einzelnes Konto zurück.
Verwenden Sie
account_ref, um ein Bankkonto zu erkennen, wenn eine Person es erneut verbindet, und id für alles innerhalb einer Verbindung.
Guthaben
GET /v3/bank/accounts/{account_id}/balances/ liefert typisierte Guthaben mit den jeweiligen Stichtagen.
type ist booked, available oder expected, und iso_type enthält den ISO-20022-Code der Bank, sofern die Bank einen angibt.
Transaktionen
GET /v3/bank/accounts/{account_id}/transactions/ liest einen Datumsbereich.
Der Endpoint akzeptiert date_from und date_to (Kalenderdaten, wie die Bank sie meldet, jeweils einschließlich), status (booked oder pending, standardmäßig beide), limit (bis zu 500) und page_token.
Die Sortierung erfolgt absteigend nach effective_date und danach nach id.
idwird von Didit vergeben und beim ersten Auftreten gespeichert. Dieselbe Buchung behält ihre ID über alle Abfragen, Synchronisierungen und Erneuerungen hinweg.identity_qualitygibt an, wie stark diese Garantie ist.bank_referenceundroute_idsind stabil.derivedbedeutet, dass die Buchung anhand ihres Inhalts zugeordnet wurde. Eine Korrektur durch die Bank kann deshalb als einremovedund einaddederscheinen.statusistbookedoderpending. Eine ausstehende Transaktion hat eine eigene ID. Bucht die Bank sie, erscheint die gebuchte Transaktion alsadded, die ausstehende alsremovedmitreason: pending_booked.pending_idist nur gesetzt, wenn die Bank beide Transaktionen verknüpft.amountist vorzeichenbehaftet: Ein negativer Betrag bedeutet Geldabfluss.directionwiederholt das Vorzeichen.bank_referenceist die unveränderliche Buchungsreferenz der Bank. Sie istnull, wenn die Bank keine liefert. Didit erzeugt diesen Wert nie selbst.categoryist die eigene Kategorisierung von Didit, sofern eine zutrifft.- Eine Korrektur einer gebuchten Transaktion durch die Bank wird als
modifiedausgegeben. Eine Rückbuchung ist eine neue Transaktion, mitreverses_id, sofern die Bank sie verknüpft.
Felder, die eine Bank nicht übermittelt, sind null
Jedes Feld, das eine Bank nicht übermittelt, istnull.
Das Institut führt in transaction_fields die Felder auf, von denen bekannt ist, dass es sie übermittelt, zusammen mit pending_transactions, pending_linkage, balance_types und history_days_max. So fallen Lücken nicht erst in der Produktion auf.
Testen Sie Ihren Code mit dem Testkunden sparse_fields in der Sandbox gegen eine Bank, die nur wenige Felder sendet.
Seitenweises Abrufen eines Datumsbereichs
Lesen Sie mitpage_token weiter, solange has_more wahr ist.
Der Token fixiert den Snapshot der Abfrage für eine Stunde: Hinzufügungen nach der ersten Seite sind darin nicht enthalten, jede Zeile wird in ihrem aktuellen Zustand ausgeliefert, und eine Zeile, die während des Abrufs entfernt wird, fällt aus den späteren Seiten heraus und erscheint im Änderungsfeed.
Ein abgelaufener Token wird mit 410 page_expired beantwortet. Starten Sie den Abruf in diesem Fall mit der ursprünglichen Abfrage neu.
Der Änderungsfeed
GET /v3/bank/connections/{id}/transactions/sync/ gibt alle Änderungen über alle Konten einer Verbindung seit einem cursor zurück.
- Ein leerer Cursor gibt alle aktuellen Transaktionen als
addedmitreset: truezurück. Ersetzen Sie Ihre Kopie damit, anstatt sie zu ergänzen. - Blättern Sie weiter mit
page_token, solangehas_moretrue ist. Speichern Sienext_cursorerst nach einer Antwort mithas_more: false. Wenn das Blättern mittendrin fehlschlägt, starten Sie vom gespeicherten Cursor neu. - Ein Cursor ist undurchsichtig und an die Verbindung und die Umgebung gebunden. Das Änderungsprotokoll kann 90 Tage lang erneut abgespielt werden. Ein älterer Cursor antwortet mit
410 cursor_expiredundbootstrap: true: Beginnen Sie erneut mit einem leeren Cursor und ersetzen Sie Ihre Kopie. removed[].reasonistpending_booked,pending_expired,bank_removedoderaccess_removed.
Header
Beide Transaktionsabfragen geben die HeaderX-RateLimit-* zurück (600 Lesezugriffe und 300 Schreibzugriffe pro Minute und Anwendung, darüber hinaus 429 mit Retry-After) sowie X-Bank-Last-Synced-At.
API-Rate-Limits und die eigenen Abruflimits der Bank sind getrennte Dinge: siehe Bankdaten bei Bedarf aktualisieren.