Skip to main content
POST
Refresh a connection

Authorizations

Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Headers

Idempotency-Key
string

Safe-retry key for POSTs. Send any unique string per logical request (a UUIDv4 is great). If the network drops and you retry with the same Idempotency-Key within 24 hours, you get the exact same response back instead of creating a duplicate. A replayed response carries Idempotent-Replayed: true.

Cached responses include failures (4xx and 5xx) too. If a call failed because of a bad input and you want to try again with the corrected input, use a fresh key — otherwise you'll keep getting the cached failure.

If the original request is still running you get 409 with a Retry-After header. Retry with the same key after that interval. Do not generate a new key to get past a 409 — a new key is a new request, which is exactly the duplicate this header prevents.

Reusing a key for a genuinely different request (different body, or a different path) returns 409 idempotency_conflict. The key is scoped to the API key that first used it, so a sandbox key and a live key never share an entry.

A replay still counts against your request rate limit, but it does not consume the daily refresh budget on POST /connections/{connection_id}/refresh, and it does not take a connection-concurrency slot.

Maximum string length: 255
Example:

"6f1a8c50-3e9c-4d4a-b1f5-2c5b9a2f7d11"

Path Parameters

connection_id
string
required

Canonical Connection id (con_<SOURCE>_<bankAccountId>). The placeholder UUID returned during initiate is rejected here with 400 — only active connections can be refreshed.

Example:

"con_FINICITY_41294"

Body

application/json

No body. Send Content-Length: 0 so the upstream load balancer doesn't reject the request with 411.

The body is of type object | null.

Response

The request was accepted but the underlying work runs asynchronously. Use the returned operation_id to poll GET /operations/{operation_id} or just wait for the matching webhook event.

Returned with 202 Accepted for async operations.

operation_id
string
required
Example:

"op_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"

status
enum<string>
required
Available options:
queued
poll_url
string<uri>
required
Example:

"https://api-sandbox.ledgersyncappv2.com/v3/operations/op_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"

estimated_seconds
integer

Rough ETA for completion. Best-effort.