---
title: "Get settlement"
method: GET
path: "/settlements/{settlementId}"
tags: ["Settlements API"]
---

# Get settlement

`GET /settlements/{settlementId}`

## Request

- Base URL: `https://api.mollie.com/v2`
- URL: `https://api.mollie.com/v2/settlements/{settlementId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://my.mollie.com/oauth2/authorize`
    - Token URL: `https://api.mollie.com/oauth2/tokens` scopes: `settlements.read`

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](get-balance-report) endpoint or the [balance transactions](list-balance-transactions) endpoint.

> 🔑 Access with
>
> [Advanced access token with **settlements.read**](/reference/authentication)
>
> [OAuth access with **settlements.read**](/reference/authentication)

## Response `200`

The settlement object.

- object
  - `resource` string, required: Indicates the response contains a settlement object. Will always contain the string `settlement` for this endpoint.
  - `id` string, required: The identifier uniquely referring to this settlement.
  - `createdAt` string: The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
  - `reference` string, nullable: The settlement's bank reference, as found in your Mollie account and on your bank statement.
  - `settledAt` string, nullable: The date on which the settlement was settled, in ISO 8601 format. For an [open settlement](get-open-settlement) or for the [next settlement](get-next-settlement), no settlement date is available.
  - `status` string, required: The status of the settlement. Possible values: `open` `pending` `processing` `processing-at-bank` `paidout` `failed`
  - `amount` object, required: The total amount of the settlement.
    - `currency` string, required: A three-character ISO 4217 currency code.
    - `value` string, required: A string containing an exact monetary amount in the given currency.
  - `balanceId` string, required: The balance token that the settlement was settled to.
  - `invoiceId` string, nullable: The ID of the oldest invoice created for all the periods, if the invoice has been created yet.
  - `periods` object: For bookkeeping purposes, the settlement includes an overview of transactions included in the settlement. These transactions are grouped into 'period' objects — one for each calendar month. For example, if a settlement includes funds from 15 April until 4 May, it will include two period objects. One for all transactions processed between 15 April and 30 April, and one for all transactions between 1 May and 4 May. Period objects are grouped by year, and then by month. So in the above example, the full `periods` collection will look as follows: `{"2024": {"04": {...}, "05": {...}}}`. The year and month in this documentation are referred as `<year>` and `<month>`. The example response should give a good idea of what this looks like in practise.
    - `<year>` object
      - `<month>` object
        - `costs` object[]: An array of cost objects, describing the fees withheld for each payment method during this period.
          - `description` string, required: A description of the cost subtotal
          - `method` string, nullable, required: The method the cost or revenue subtotal applies to. This is usually a payment method, but can also represent a correction or transaction type that is not tied to a specific payment method. Possible values: `alma` `applicationfee` `authorizationreversal` `bacs` `bancomatpay` `bancontact` `banktransfer` `belfius` `billie` `billink` `bitcoin` `bizum` `blik` `capture` `chargeback` `creditcard` `directdebit` `eps` `giftcard` `giropay` `ideal` `in3` `inghomepay` `kbc` `kickback` `klarna` `klarnapaylater` `klarnapaynow` `klarnasliceit` `mbway` `mobilepay` `multibanco` `mybank` `paybybank` `paypal` `paysafecard` `podiumcadeaukaart` `pointofsale` `przelewy24` `refund` `riverty` `rollingreserve` `satispay` `shiftedfee` `sofort` `swish` `trustly` `twint` `vipps` `voucher` `wero`
          - `count` integer, required: The number of fees
          - `rate` object, required: The service rates, further divided into `fixed` and `percentage` costs.
            - `fixed` object: In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
              - …
            - `percentage` string
          - `amountNet` object, required: The net total cost, i.e. excluding VAT
            - `currency` string, required: A three-character ISO 4217 currency code.
            - `value` string, required: A string containing an exact monetary amount in the given currency.
          - `amountVat` object, nullable, required: The applicable VAT
            - `currency` string, required: A three-character ISO 4217 currency code.
            - `value` string, required: A string containing an exact monetary amount in the given currency.
          - `amountGross` object, required: The gross total cost, i.e. including VAT
            - `currency` string, required: A three-character ISO 4217 currency code.
            - `value` string, required: A string containing an exact monetary amount in the given currency.
        - `revenue` object[]: An array of revenue objects containing the total revenue for each payment method during this period.
          - `description` string, required: A description of the revenue subtotal
          - `method` string, nullable, required: The method the cost or revenue subtotal applies to. This is usually a payment method, but can also represent a correction or transaction type that is not tied to a specific payment method. Possible values: `alma` `applicationfee` `authorizationreversal` `bacs` `bancomatpay` `bancontact` `banktransfer` `belfius` `billie` `billink` `bitcoin` `bizum` `blik` `capture` `chargeback` `creditcard` `directdebit` `eps` `giftcard` `giropay` `ideal` `in3` `inghomepay` `kbc` `kickback` `klarna` `klarnapaylater` `klarnapaynow` `klarnasliceit` `mbway` `mobilepay` `multibanco` `mybank` `paybybank` `paypal` `paysafecard` `podiumcadeaukaart` `pointofsale` `przelewy24` `refund` `riverty` `rollingreserve` `satispay` `shiftedfee` `sofort` `swish` `trustly` `twint` `vipps` `voucher` `wero`
          - `count` integer, required: The number of payments
          - `amountNet` object, required: The net total of received funds, i.e. excluding VAT
            - `currency` string, required: A three-character ISO 4217 currency code.
            - `value` string, required: A string containing an exact monetary amount in the given currency.
          - `amountVat` object, nullable, required: The applicable VAT
            - `currency` string, required: A three-character ISO 4217 currency code.
            - `value` string, required: A string containing an exact monetary amount in the given currency.
          - `amountGross` object, required: The gross total of received funds, i.e. including VAT
            - `currency` string, required: A three-character ISO 4217 currency code.
            - `value` string, required: A string containing an exact monetary amount in the given currency.
        - `invoiceId` string, nullable: The ID of the invoice created for this period, if the invoice has been created already.
        - `invoiceReference` string, nullable: The invoice reference, if the invoice has been created already.
  - `_links` object, required: An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    - `self` object, required: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `payments` object: The API resource URL of the [payments](list-payments) included in this settlement.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `captures` object: The API resource URL of the [captures](list-captures) included in this settlement.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `refunds` object: The API resource URL of the [refunds](list-refunds) deducted from this settlement.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `chargebacks` object: The API resource URL of the [chargebacks](list-chargebacks) deducted from this settlement.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `invoice` object, nullable: The API resource URL of the [invoice](list-invoices).
      - `href` string: The actual URL string.
      - `type` string: The content type of the page or endpoint the URL points to.
    - `documentation` object: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.

## Other responses

- `404`: No entity with this ID exists.
- `429`: Rate Limit has been reached.

---

[API](https://skmtc.dev/mollie/apis/business-operations.md) - [All operations](https://skmtc.dev/mollie/apis/business-operations/llms.txt) - [OpenAPI document](https://skmtc.dev/mollie/apis/business-operations/revisions/d51d76f4e5d9?raw)
