CAcardda
Bank key

Sync bank key

Enqueues a background job that re-fetches the bank accounts exposed by this credential and refreshes their capability data. Use it to repopulate stale account/permission information without deleting and recreating the key.

The job runs asynchronously — this endpoint only acknowledges the enqueue and responds 202 Accepted. Requests are debounced: if a sync was already enqueued for this key within the last 30 seconds, the request is a no-op and the response carries enqueued: false (still 202). This protects the upstream bank from rapid retries.

post/v1/banking/bank_keys/{bank_key_id}/sync

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/banking/bank_keys/{bank_key_id}/sync
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1banking~1bank_keys~1%7Bbank_key_id%7D/get/parameters/1 (unresolved $ref)

Response

Sync acknowledged (enqueued, or skipped if debounced)

idstring uuid required

The id of the bank key.

enqueuedboolean required

true when a fresh sync job was enqueued. false when a sync for this key was already enqueued within the debounce window and this request was a no-op.

Example response

{
  "id": "47b93e3d-36a6-423a-acbe-c23b5484c3ed",
  "enqueued": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.