The Get Balances
endpoint retrieves a list of balances associated with a specific bank account that has been linked by a user (or business) via LinkSDK, identified by both the entity_id
and the account_id
. The accountId can be found by making a call to the /accounts endpoint.
Each balance object contains fields such as balance type
(e.g., CLOSING_AVAILABLE, INTERIM_BOOKED, etc..), amount
, currency
, credit/debit indicator
, and optional credit_line
details that indicate available or agreed credit facilities tied to the account.
Balance types can vary based on the bank and the nature of the account, and multiple types of balances may be available for the same account at the same time.
Requires an active entity with the balances
permission to use.