Balances API
List balances
Retrieve a list of the organization's balances, including the primary balance.
The results are paginated.
get/v2/balances
Query parameters
currencystring nullable
Example:EUR
Optionally only return balances with the given currency. For example: EUR.
fromstring nullable
Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
limitinteger nullable
Example:50
The maximum number of items to return. Defaults to 50 items.
testmodeboolean
You can enable test mode by setting the testmode query parameter to true.
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
Headers
idempotency-keystring
Example:123e4567-e89b-12d3-a456-426
A unique key to ensure idempotent requests. This key should be a UUID v4 string.
Response
A list of balance objects. For a complete reference of the balance object, refer to the Get balance endpoint documentation.