MOmollie
Settlements API

Get settlement

Retrieve a single settlement by its ID.

To lookup settlements by their bank reference, replace the ID in the URL by a reference. For example: 1234567.2404.03.

A settlement represents a transfer of your balance funds to your external bank account.

Settlements will typically include a report that details what balance transactions have taken place between this settlement and the previous one.

For more accurate bookkeeping, refer to the balance report endpoint or the balance transactions endpoint.

🔑 Access with

Advanced access token with settlements.read

OAuth access with settlements.read

get/settlements/{settlementId}

Request

  • Base URL
    https://api.mollie.com/v2
  • URL
    https://api.mollie.com/v2/settlements/{settlementId}
  • 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

Response

The settlement object.

resourcestring required

Indicates the response contains a settlement object. Will always contain the string settlement for this endpoint.

idstring required

The identifier uniquely referring to this settlement.

createdAtstring

The entity's date and time of creation, in ISO 8601 format.

referencestring nullable

The settlement's bank reference, as found in your Mollie account and on your bank statement.

settledAtstring nullable

The date on which the settlement was settled, in ISO 8601 format.

For an open settlement or for the next settlement, no settlement date is available.

statusstring required

The status of the settlement.

Possible values: open pending processing processing-at-bank paidout failed

balanceIdstring required

The balance token that the settlement was settled to.

invoiceIdstring nullable

The ID of the oldest invoice created for all the periods, if the invoice has been created yet.

Example response

{
  "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"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

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