Get account balance

Available in 🇦🇺 AU🇪🇺 EU🇬🇧 UK

Not yet available in 🇧🇷 BR

Your account balance

Use this endpoint to retrieve the current balance of your account. The balance returned will be correct at that point in time.

This can be used for Volt Accounts and third-party connected accounts operated by one of our banking partners. In the case of third-party providers we will show the total balance of transactions currently in RECEIVED status that make up part of the balance.

Usage

Authentication

You will need to submit an authentication request to the API first, in order to obtain the access token that you’ll need in order to request a balance using this endpoint.

Find out more about API Authentication

View in API docs

Request

Sandbox
Production

GET https://api.sandbox.volt.io/accounts/:accountId/balances

GET https://api.volt.io/accounts/:accountId/balances

Query parameters

Name	Type	Description
`accountId`	String [uuid]	id of the account to retrieve a balance for

Response

200 OK

The example response below shows a balance of GBP 9983.89.

GET /accounts/:accountId/balances

{
  "availableBalance": 998389,
  "currency": "GBP",
  "timestamp": "2024-05-29T09:57:41+00:00"
}

Fields in response

Name	Type	Description
`availableBalance`	Numeric [integer]	Balance of the account in minor units (eg cents, pence)
`currency`	String (3)	Currency code (3-letter ISO code)
`timestamp`	Timestamp	Timestamp in UTC for the balance

Error handling

401 Unauthorized

Your credentials were invalid, usually because a valid authentication token was not supplied. It may be that the token you used has expired. You will need to re-authenticate and then resubmit this request with updated credentials

Example unauthorized message (HTTP 401)

{
  "exception": {
    "code": 401,
    "message": "Unauthorized"
  }
}

403 Access denied

Either you don’t have permission to view account balances or the account id you’ve specified is invalid.

Example access denied message (HTTP 403)

{
  "exception": {
    "code": 403,
    "message": "Access Denied."
  }
}

422 Request cannot be processed

The account provider does not provide an account balance service. This will only occur for specific accounts operated by one of our third-party providers. If you receive this response, please contact Volt support for clarification.

Example unprocessable request message (HTTP 422)

{
  "exception": {
    "code": 422,
    "message": "Provider does not support this function"
  }
}