Get an account's balance

The account balance is expressed in two ways: cleared balance and effective balance.

• The cleared balance is the balance of settled transactions and so does not include pending transactions. The cleared end of day balance is used to calculate interest.
• The effective balance is the balance of settled and pending outgoing transactions. This is the balance most commonly presented to the account holder (e.g. in-app).

clearedBalance and effectiveBalance hold the values for the main account only, excluding balances in spaces, savings goals etc. totalClearedBalance and totalEffectiveBalance hold the corresponding values totalled across the main account and all spaces, savings goals etc.

Many payment types settle almost instantly (e.g. faster payments). Card transactions usually take a few days to settle and will remain pending for this time. We've got a blog post on how card transactions work.

To check whether the account has enough money to make a payment, use the confirmation of funds endpoint instead.