Docs API Reference Bank Account/bff/bank-account/{externalId}/sync

/bff/bank-account/{externalId}/sync

Immediately re-fetches the latest Fio feed for one account, bypassing the adaptive-scheduler next_sync_date and the 2 h in-memory cache. Returns the number of newly imported transactions. For an account whose first sync never succeeded (no IBAN yet), the first-sync flow is restarted in the background instead and pending: true is returned. Lets an operator recover from a stuck first sync (BIZKIT-35) without waiting for the hourly cron.

Bank accountpostBffBank-accountByExternalIdSync

Parameters

1 path

Path parameters

· 1

externalIdstringRequired

Bank account external ID returned by the list endpoint.

Exampleexample_externalId

Response schema

1 status code documented

200Success

successbooleanRequired

importednumberRequired

Number of new transactions imported in this run.

ibanstring | nullRequired

IBAN after the sync (newly discovered for a brand-new placeholder).

One of 2:

Variant 1

string

Variant 2

null

pendingbooleanRequired

True when the account never completed its first sync: the retry was started in the background and the outcome appears in connectorLastStatus of the list endpoint.

Response example

application/json

{
  "success": false,
  "imported": 0,
  "pending": false
}

Request example

POST /bff/bank-account/{externalId}/sync

post

curl -X POST "https://api.bizkithub.com/bff/bank-account/example_externalId/sync" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key