Check current total balance

Returns the consolidated balance of the transactional account, including the gross balance, net balance, and a breakdown of available amounts per integrated banking provider.


Use this endpoint to query, in real time, the available balance of the transactional account.

The response returns:

  • gross_balance: Gross balance recorded in the platform's internal wallet.
  • net_balance: Net balance recorded in the platform's internal wallet.
  • balance: Available balance in the respective banking provider's account at the time of the query.
  • providers_total_balance: Sum of balances queried in real time from the banking providers enabled for the account. May differ from net_balance if there is a timing gap between the internal record and the banking settlement.
  • providers: List with the balance breakdown per banking provider. Each item identifies the provider, the associated account, and the available balance queried in real time.
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json