Account Balance
Account balance introduction
Account Balance Calculation
When using Volt Accounts or Connected Accounts, you can check the account balance in the Accounts section of Fuzebox or via the API. In Fuzebox, you will be able to see your general account balance, as well as the balance available for the next settlement. the balance shown, will be up to date at the time of the request.
Account balance
The account balance is a sum of all available funds calculated from the last Settlement. This includes collections from Gateway in the RECEIVED status, collected funds from Credits with CONFIRMED outgoing transactions incl. Refunds and Payouts subtracted.
Settlement amount
The Settlement amount is the balance available to be settled next: manually or in a batch. If a balance reserve is configured, the difference between the Account balance and the Settlement amount will be the reserve.
Account Balance from the API
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.
Request
Production host is https://api.volt.io and sandbox https://api.sandbox.volt.io
GET /accounts/:accountId/balances response example
Parameters
table id of the account to retrieve a balance for
| Name | Type | Description |
|---|---|---|
| accountId | String [uuid] | id of the account to retrieve a balance for |
Response
{
"availableBalance": 998389,
"currency": "GBP",
"timestamp": "2024-05-29T09:57:41+00:00"
}Response fields
| 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 |
How is this guide?
Last updated on