MOmollie
Settlements API

List settlements

Changed on

Retrieve a list of all your settlements.

The results are paginated.

get/v2/settlements

Request

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

Query parameters

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.

balanceIdstring
Example:bal_gVMhHKqSSRYJyPsuoPNFH

Provide the token of the balance to filter the settlements by. This is the balance token that the settlement was settled to.

yearstring nullable
Example:2025

Provide the year to query the settlements. Must be used combined with month parameter

monthstring nullable
Example:1

Provide the month to query the settlements. Must be used combined with year parameter

currencies'EUR' | 'GBP' | 'CHF' | 'DKK' | 'NOK' | 'PLN' | 'SEK' | 'USD' | 'CZK' | 'HUF' | 'AUD' | 'CAD' | 'RON'
Example:EUR

Provides the currencies to retrieve the settlements. It accepts multiple currencies in a comma-separated format.

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 settlement objects. For a complete reference of the settlement object, refer to the Get settlement 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": {
    "settlements": [
      {
        "resource": "settlement",
        "id": "stl_5B8cwPMGnU",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "reference": "07049691.2406.01",
        "settledAt": "2025-03-31T12:54:39+00:00",
        "status": "paidout",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
        "invoiceId": "inv_aHbjjdrUdm",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "payments": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "captures": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "refunds": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "chargebacks": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "invoice": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "documentation": {
            "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

  • 7eb5bf6b29ddRevision changes
    • warning

      added the new processing enum value to the /////////// response property for the response status

  • 66dee9998c09Revision changes
    • warning

      added the new wero enum value to the //////////// response property for the response status

    • warning

      added the new wero enum value to the //////////// response property for the response status