Get bank account balance
GET/v1/bank-accounts/:bankAccountId/balance
Returns the current balance for a specific bank account within the authenticated user's organisation.
The response includes two balance fields:
balance: The current ledger balance of the account.availableBalance: The balance available for spending, which may be lower thanbalancedue to pending or reserved transactions.
Both values are returned as Money objects with amount and currency fields.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 502
- 503
- 504
Bank account balance information retrieved successfully
Response Headers
Maximum number of requests allowed in the current rate limit window for the used scope.
Number of requests remaining in the current rate limit window.
Unix timestamp (seconds since epoch, UTC) when the rate limit window resets.
The OAuth scope bucket to which this rate limit applies: read or write.
Bad request (e.g., invalid bank account ID format)
Unauthorized
Forbidden (e.g., user has no organizations, insufficient scope privileges)
Bank account not found in organization
Rate limit exceeded. Reduce request frequency and retry after the indicated number of seconds.
Response Headers
Maximum number of requests allowed in the current rate limit window for the used scope.
Number of requests remaining in the current rate limit window.
Unix timestamp (seconds since epoch, UTC) when the rate limit window resets.
The OAuth scope bucket to which this rate limit applies: read or write.
Number of seconds to wait before retrying. Only present on 429 Too Many Requests responses.
Internal server error
Bad gateway. An upstream service could not be reached.
Service temporarily unavailable. An upstream service returned a 503 error.
Gateway timeout. An upstream service did not respond in time.