WARNING: The Balances resource will be deprecated in October 2023.
A balance represents the amount of funds available in a checking or savings account over a period of time.
- If your Balance request is not for a checking or savings account, we return an empty array.
-
If we cannot calculate the balance for a given day within your requested
period, the
balance
andcurrent_balance
fields will returnnull
for that day.
Savings accounts that do not have any associated transactions (for example, some poupança accounts in Brazil) will not contain accurate Balance information. We do not recommend using the Balance endpoint for these types of accounts.
Savings accounts vary from institution to institution, so we recommend that you first use our Retrieve transactions for a link request, adding the
account
in the request body, to see if the Savings account has any associated transactions.