​
Balance Object

The Balance object represents the current balance of an account, including available and pending funds.

​
Properties

​
accountId
string
required
The ID of the account this balance belongs to
​
available
number
The amount of available funds
​
current
number
The current balance amount including pending transactions
​
currency
string
The currency of the balance (ISO 4217 code)
​
timestamp
timestamp
The timestamp when the balance was last updated

​
Endpoints

​
Retrieve Balance

Retrieves the balances for the accounts that the user has consented to share access to. 
POST /api/service/data/account-balances/list
Request
Response
{
    "balances": [
        {
            "accountId": "bafab4a9-2532-5b78-8c6f-4b9b0ecb6302",
            "available": "30.0000",
            "current": "30.0000",
            "currency": "GBP",
            "timestamp": "2025-05-05T09:39:43.748Z"
        },
        {
            "accountId": "e4a387be-81bd-5036-ac04-90366b6c0cb8",
            "available": "10.0000",
            "current": "10.0000",
            "currency": "EUR",
            "timestamp": "2025-05-05T09:39:43.748Z"
        }
    ]
}