Zum Hauptinhalt springen
POST
curl
Der Endpoint „Refresh a Bank Connection“ von Didit fordert eine sofortige Synchronisierung an und antwortet mit 202 und der sync_id. Mit "wait": true wartet der Aufruf bis zu 25 Sekunden und liefert die abgeschlossene Synchronisierung in einem einzigen Aufruf, ohne zusätzliche Kosten. Die Bank begrenzt den unbeaufsichtigten Zugriff, daher kann der Aufruf mit 429 refresh_limit_reached und Retry-After antworten. Siehe Bankdaten bei Bedarf aktualisieren.

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, zu finden unter Developers -> API keys in der Business Console. Der primäre Schlüssel hat vollen Zugriff. Ein benannter Schlüssel kann eingeschränkt werden: pro Ressource keine, nur Lese- oder nur Schreibrechte, begrenzt auf einzelne Workflows oder nur auf genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist. 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste kam. 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibzugriff auf Sitzungen erhält Sitzungslinks und Tokens als null. Siehe https://docs.didit.me/console/api-keys.

Header

Idempotency-Key
string

Optionaler Schlüssel zur Wiederholungssicherheit für einen Vorgang, den Sie selbst wählen, bis zu 255 Zeichen (eine UUID eignet sich). Eine Anfrage, die mit demselben Schlüssel, demselben Endpoint, denselben Query-Parametern und demselben Body wiederholt wird, erhält die erste Antwort mit demselben Status und demselben Body zurück und wird kein zweites Mal ausgeführt oder berechnet. Derselbe Schlüssel mit einem anderen Endpoint, anderen Query-Parametern oder einem anderen Body liefert 409 mit idempotency_key_reused. Solange die erste Anfrage noch läuft, liefert er 409 mit idempotency_key_in_progress und Retry-After. Eine fehlgeschlagene Anfrage (jeder 4xx- oder 5xx-Fehler) wird nicht gespeichert, sodass Sie sie mit demselben Schlüssel erneut senden können. Schlüssel gehören zu Ihrer Anwendung, unabhängig davon, ob Sie mit einem API-Schlüssel oder einem Zugriffstoken aufrufen. Siehe Wiederholungsversuche und Idempotenz.

Required string length: 1 - 255
Prefer
string

wait=<seconds> hält den Aufruf bis zu dieser Anzahl von Sekunden an, maximal 25, wie wait: true im Anfragetext.

Beispiel:

"wait=25"

Pfadparameter

id
string<uuid>
erforderlich

Die Verbindungs-ID.

Body

application/json

Optionaler Request-Body einer Aktualisierung.

wait
boolean
Standard:false

true holds the call for up to 25 seconds and answers 200 with the finished sync, so one request returns fresh data. If the bank has not answered in that time the call answers 202: read the sync with get_sync_run using the sync_id, or subscribe to bank.sync.completed. bank.data.updated follows only when the sync stores changes. The header Prefer: wait=<seconds> (up to 25) does the same.

Antwort

Die Synchronisierung wurde innerhalb von 25 Sekunden abgeschlossen.

Eine abgeschlossene Synchronisierung, die von einer Aktualisierung mit wait zurückgegeben wird: der Synchronisierungslauf mit seinem outcome, die Anzahl je Konto in results und balances_changed.

id
string<uuid>
erforderlich
connection_id
string<uuid>
erforderlich
trigger
enum<string>
erforderlich
Verfügbare Optionen:
initial,
scheduled,
requested
status
enum<string>
erforderlich
Verfügbare Optionen:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
erforderlich
finished_at
string<date-time> | null
erforderlich
results
object[]
erforderlich

Was der Lauf pro Konto und Ressource getan hat.

error
object | null
erforderlich

Warum der Lauf insgesamt fehlgeschlagen ist. null, wenn nicht. Fehler einzelner Konten und Ressourcen stehen in results.

outcome
enum<string>
erforderlich

Wie die Synchronisation endete.

Verfügbare Optionen:
succeeded,
partial,
failed
balances_changed
boolean
erforderlich

Ob sich irgendein Guthaben geändert hat.

Zuletzt geändert am 22. November 2026