Settlements API

List settlements

Retrieve a list of all your settlements.

The results are paginated.

🔑 Access with

Advanced access token with settlements.read

OAuth access with settlements.read

get/settlements

Request

Base URL
https://api.mollie.com/v2
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

Example:stl_jDk30akdN

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 nullable

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

currenciesstring nullable

Example:EUR

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

Possible values: EUR GBP CHF DKK NOK PLN SEK USD CZK HUF AUD CAD RON

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",
        "periods": {
          "<year>": {
            "<month>": {
              "costs": [
                {
                  "description": "Credit card - Visa debit consumer domestic",
                  "method": "creditcard",
                  "count": 10,
                  "rate": {
                    "fixed": {
                      "currency": "EUR",
                      "value": "10.00"
                    },
                    "percentage": "2.5"
                  },
                  "amountNet": {
                    "currency": "EUR",
                    "value": "10.00"
                  },
                  "amountVat": {
                    "currency": "EUR",
                    "value": "10.00"
                  },
                  "amountGross": {
                    "currency": "EUR",
                    "value": "10.00"
                  }
                }
              ],
              "revenue": [
                {
                  "description": "Credit card",
                  "method": "creditcard",
                  "count": 10,
                  "amountNet": {
                    "currency": "EUR",
                    "value": "10.00"
                  },
                  "amountVat": {
                    "currency": "EUR",
                    "value": "10.00"
                  },
                  "amountGross": {
                    "currency": "EUR",
                    "value": "10.00"
                  }
                }
              ],
              "invoiceId": "inv_aHbjjdrUdm",
              "invoiceReference": "MOLR2021.0001399669"
            }
          }
        },
        "_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"
          }
        }
      }
    ]
  },
  "_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.