Skip to main content
POST
curl
Didit’s Refresh a Bank Connection endpoint asks for a sync now and answers 202 with the sync_id. Send "wait": true to hold up to 25 seconds and get the finished sync in one call, at no extra charge. The bank limits unattended access, so the call can answer 429 refresh_limit_reached with Retry-After. See Refresh bank data on demand.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Headers

Idempotency-Key
string

Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns 409 idempotency_key_reused, and while the first request is still running, 409 idempotency_key_in_progress with Retry-After. A failed request (any 4xx or 5xx) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See Retries and idempotency.

Required string length: 1 - 255
Prefer
string

wait=<seconds> holds the call for up to that many seconds, at most 25, like wait: true in the body.

Example:

"wait=25"

Path Parameters

id
string<uuid>
required

The connection id.

Body

application/json

Optional body of a refresh.

wait
boolean
default: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.

Response

The sync finished within 25 seconds.

A finished sync returned by a refresh with wait: the sync run with its outcome, the per-account counts in results and balances_changed.

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

What the run did, per account and resource.

error
object | null
required

Why the run failed as a whole. null when it did not. Errors of single accounts and resources are in results.

outcome
enum<string>
required

How the sync ended.

Available options:
succeeded,
partial,
failed
balances_changed
boolean
required

Whether any balance changed.

Last modified on November 22, 2026