Balances

Get the latest known balance for an account

Returns the bank aggregator's most recent balance snapshot for the account. This does not force the institution to recompute the balance — aggregators refresh on their own schedule (often daily, and for brokerage accounts only once the institution posts an update). Compare balanceAsOf (when the data was refreshed) with retrievedAt (when BankSync read it from the aggregator — the cached answer's time on a cache hit) to judge freshness; balanceAsOf is null when the provider does not report it, which means UNKNOWN rather than fresh. Responses may be served from a cache up to 6 hours old: X-BankSync-Cache says hit, miss or bypass, and Age is the cached answer's age in seconds.

get/v1/banks/{bid}/accounts/{aid}/balances

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/banks/{bid}/accounts/{aid}/balances
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

bidstring required

Bank ID

aidstring required

Account ID

Response

Live balance for the account

successtrue required

Changes

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