Real Time Balance

The real-time balance endpoint fetches the account balance directly from the financial institution without triggering a full item sync. This is useful when you need up-to-date balance information between regular sync cycles.

GET /accounts/{id}/balance

{
  "balance": 1500.50,
  "blockedBalance": 0,
  "automaticallyInvestedBalance": 200,
  "closingBalance": 1500.50,
  "currencyCode": "BRL",
  "updateDateTime": "2024-01-15T10:30:00Z"
}

The balance value returned by this endpoint is calculated using the same logic as a full item execution, including the Itaú and Banco do Brasil rule for automatically invested amounts. The one exception is the overdraft adjustment: a full execution returns balance as the negative of the overdraft used when the institution reports zero and overdraft is in use, and this endpoint does not. See Bank account balances on Open Finance.

When you call this endpoint, the account resource is updated with what the institution answered: balance, and, when reported, bankData.closingBalance and bankData.automaticallyInvestedBalance. Any subsequent GET /accounts/{id} request reflects the values fetched by the real-time balance call, so both endpoints stay consistent without waiting for the next sync. Amounts the institution did not report are left as the last sync stored them.

Rate limiting: The rate limit for this endpoint is shared with the full item execution. Requests to the real-time balance endpoint and item syncs both count toward the same rate limit quota imposed by the financial institution. If the institution rate-limits the request, you will receive a 429 response.

See Get real-time balanceAPI in the API reference for more details.