List account balances

Retrieve balance information for all your accounts. Each result includes the account’s current balance and currency, cumulative credit and debit totals, and where applicable, a funding balance.

Use AccountId to match each result to your records. To inspect the entries behind a balance, list the account's entries.

Endpoints

EnvironmentMethod and URL
StagingGET https://staging-api.vitessepsp.com/api/accountBalances
Production – UK HubGET https://api.vitessepsp.com/api/accountBalances
Production – US HubGET https://api.us.vitesse.io/api/accountBalances

For help choosing an environment, see Environment.

Access requirements

Configure the following access:

OAuth scopeIdentity client role
APIAccounts.Lookup

For more information about scopes, see Authentication. For information about the access granted by specific roles, see Identity client roles.

Send the request

This example uses the Staging environment:

curl --request GET \
  --url 'https://staging-api.vitessepsp.com/api/accountBalances' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Accept: application/json'

Replace <access-token> with a valid access token that contains the required scope, and any example values with your own details.

Example response

A successful request returns 200 OK and a JSON array of account balance summaries.

This example shows two funding accounts:

[
  {
    "AccountId": 4111,
    "AccountName": "Insurova - Carrier Funding",
    "Alias": "INSFUNDGBP",
    "AdditionalAlias": "INSUROVA-GBP",
    "TertiaryAlias": "CARRIER-FUNDING-GBP",
    "Balance": 1773221.43,
    "CreatedOn": "2026-05-01T09:00:00Z",
    "CreditTotal": 2000148.76,
    "Currency": "GBP",
    "DebitTotal": 226927.33,
    "FcpEnabled": false,
    "FundingBalance": 1773221.43,
    "FundingMerchantId": 6789,
    "FundingMerchantName": "Insurova Ltd",
    "FundingMerchantReportingName": "Insurova",
    "LastUpdatedOn": "2026-09-14T10:45:00Z",
    "MerchantAccountSubtype": "Funding",
    "MerchantAccountProductType": "NonLloyds", 
    "SecurityGroupId": 101,
    "UCR": "UCR-2026-000111",
    "BlendId": 456
  },
  {
    "AccountId": 4113,
    "AccountName": "Rock Solid Insurance - Carrier Funding",
    "Alias": "RSFUNDGBP",
    "AdditionalAlias": "ROCK-SOLID-GBP",
    "TertiaryAlias": "CARRIER-FUNDING-GBP",
    "Balance": 1002809.58,
    "CreatedOn": "2026-05-04T11:30:00Z",
    "CreditTotal": 1100326.91,
    "Currency": "GBP",
    "DebitTotal": 97517.33,
    "FcpEnabled": false,
    "FundingBalance": 1002809.58,
    "FundingMerchantId": 6790,
    "FundingMerchantName": "Rock Solid Insurance Ltd",
    "FundingMerchantReportingName": "Rock Solid",
    "LastUpdatedOn": "2026-09-14T11:20:00Z",
    "MerchantAccountSubtype": "Funding",
    "MerchantAccountProductType": "NonLloyds", 
    "SecurityGroupId": 102,
    "UCR": "UCR-2026-000113",
    "BlendId": 457
  }
]
📘

Do not use MerchantAccountProductType in application logic. Its value can change without notice.

💡

Account balances can change after you retrieve them. This request does not reserve funds or guarantee sufficient funds for a later payment or account movement.

Troubleshoot the request

If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.

If Vitesse returns 200 OK with an empty array, check which accounts the identity client can access.

Contact Support if you expected Vitesse to return accounts.

For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.

Next steps

To view a specific summary, see Retrieve an account balance. To review account activity, see List account entries.