Get Total Balance

Returns the total available balance along with pending incoming and outgoing transaction amounts for the user's accounts.

Response includes:

  • balance: Current available balance
  • pendingIncoming: Sum of pending incoming transactions (positive amounts)
  • pendingOutgoing: Sum of pending outgoing transactions (absolute values of negative amounts)
  • filters: Applied filters if any (optional)

List of possible error codes:

CodeStatusDescription
INVALID_QUERY_PARAMETERS400Query parameters are invalid
FORBIDDEN403Access denied to accounts
INTERNAL_ERROR500Internal server error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint is shared across Individual, Business Owner, and Operator user types.

Query Params
accountIds
array of uint64s

Array of account IDs to filter by

accountIds
accountTypes
array of strings

Array of account types to filter by (e.g., "Checking", "Savings")

accountTypes
Responses

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