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,
"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 — there is no difference in how the balance is derived.
When you call this endpoint, the account resource is also updated with the new balance. Any subsequent GET /accounts/{id} request will reflect the value fetched by the real-time balance call.
This endpoint is only available for Open Finance connectors. Calling it on non-Open Finance accounts will return an error.
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.
| Response Code | Description |
|---|---|
200 | Balance fetched and account updated |
404 | Account not found for the given ID |
429 | Rate limited by the financial institution — retry later |
500 | Error fetching the balance from the connector |
See Get real-time balance in the API reference for more details.
Updated about 5 hours ago