Retrieve an account balance
Retrieve the account balance information for the specified account, including cumulative credit and debit totals, and funding balance.
To investigate its credits and debits, use List account entries.
Endpoints
| Environment | Endpoint |
|---|---|
| Staging | GET https://staging-api.vitessepsp.com/api/accountBalances/{Id} |
| Production – UK Hub | GET https://api.vitessepsp.com/api/accountBalances/{Id} |
| Production – US Hub | GET https://api.us.vitesse.io/api/accountBalances/{Id} |
Replace {Id} with the account’s AccountId.
For help choosing an environment, see Environment.
Access requirements
Configure the following access:
| OAuth scope | Identity client role | Required for |
|---|---|---|
API | Accounts.Lookup | Retrieving an account balance. |
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 and retrieves the balance summary for account 4111:
curl --request GET \
--url 'https://staging-api.vitessepsp.com/api/accountBalances/4111' \
--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 one account balance.
This abridged example shows the balance summary of a funding account:
{
"AccountId": 4111,
"AccountName": "Insurova - Carrier Funding",
"Alias": "INSFUNDGBP",
"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",
"Overdraft": 0,
"SecurityGroupId": 101,
"UCR": "UCR-2026-000111",
"BlendId": 456
}Credit and debit totals cover the period since account creation, rather than a selected reporting period.
To investigate the activity behind these totals, use List account entries.
The account balance can change after you retrieve it. 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 404 Not Found, check that the account ID is correct and belongs to the environment you are calling.
For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.
Next steps
To find another balance, see List account balance. To review account activity, see List account entries.
Updated 18 days ago