MOmollie
Balances API

List balances

Retrieve a list of the organization's balances, including the primary balance.

The results are paginated.

🔑 Access with

Advanced access token with balances.read

OAuth access with balances.read

get/balances

Request

  • Base URL
    https://api.mollie.com/v2
  • URL
    https://api.mollie.com/v2/balances
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: balances.read

Query parameters

currencystring nullable
Example:EUR

Optionally only return balances with the given currency. For example: EUR.

fromstring
Example:bal_gVMhHKqSSRYJyPsuoPNFH

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.

Response

A list of balance objects. For a complete reference of the balance object, refer to the Get balance endpoint documentation.

countinteger required

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "balances": [
      {
        "resource": "balance",
        "id": "bal_gVMhHKqSSRYJyPsuoPNFH",
        "mode": "live",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "currency": "EUR",
        "description": "Balance description",
        "status": "active",
        "transferFrequency": "daily",
        "transferThreshold": {
          "currency": "EUR",
          "value": "10.00"
        },
        "transferReference": "RF12-3456-7890-1234",
        "transferDestination": {
          "type": "bank-account",
          "beneficiaryName": "John Doe"
        },
        "availableAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "pendingAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.