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

# List settlement refunds

`GET /settlements/{settlementId}/refunds`

## Request

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

Retrieve all refunds 'deducted' from the given settlement.

The response is in the same format as the response of the [List refunds endpoint](list-refunds).

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

## Query parameters

- `from` string
- `limit` integer, nullable
- `embed` 'payment'

## Response `200`

A list of refund objects.

- object
  - `count` integer, 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.
  - `_embedded` object, required
    - `refunds` object[], required: An array of refund objects.
      - `resource` string, required: Indicates the response contains a refund object. Will always contain the string `refund` for this endpoint.
      - `id` string, required: The identifier uniquely referring to this refund. Mollie assigns this identifier at refund creation time. Mollie will always refer to the refund by this ID. Example: `re_4qqhO89gsT`.
      - `mode` string, required: Whether this entity was created in live mode or in test mode. Settlements are always in live mode. Possible values: `live`
      - `description` string, nullable, required: The description of the refund that may be shown to your customer, depending on the payment method used.
      - `amount` object, required: The amount refunded to your customer with this refund. The amount is allowed to be lower than the original payment amount.
        - `currency` string, required: A three-character ISO 4217 currency code.
        - `value` string, required: A string containing an exact monetary amount in the given currency.
      - `settlementAmount` object, nullable: The amount deducted from your account balance for this refund, converted to the currency your account is settled in. Always a **negative** amount. For refunds not directly processed by Mollie (e.g. PayPal), the settlement amount is zero.
        - `currency` string, required: A three-character ISO 4217 currency code.
        - `value` string, required: A string containing an exact monetary amount in the given currency.
      - `metadata` union, required: Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
        - string
        - number
        - object
        - string[]
      - `paymentId` string, required: The unique identifier of the payment this refund was created for. The full payment object can be retrieved via the payment URL in the `_links` object.
      - `settlementId` string, nullable: The identifier referring to the settlement this refund was settled with. This field is omitted if the refund is not settled (yet).
      - `status` 'queued' | 'pending' | 'processing' | 'refunded' | 'failed' | 'canceled', required: The refund's status. Settlement refunds are normally `refunded`, but can be `failed` if the refund could not be processed. Possible values: `refunded` `failed`
      - `createdAt` string, required: The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      - `externalReference` object
        - `type` string: Specifies the reference type Possible values: `acquirer-reference`
        - `id` string: Unique reference from the payment provider
      - `reverseRouting` boolean, nullable: *This feature is only available to marketplace operators.* With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants, by providing the `routing` object during [payment creation](create-payment). When creating refunds for these *routed* payments, by default the full amount is deducted from your balance. If you want to pull back the funds that were routed to the connected merchant(s), you can set this parameter to `true` when issuing a full refund. For more fine-grained control and for partial refunds, use the `routingReversals` parameter instead.
      - `routingReversals` object[], nullable: *This feature is only available to marketplace operators.* When creating refunds for *routed* payments, by default the full amount is deducted from your balance. If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount needs to be reversed from which merchant(s). If you simply want to fully reverse the routed funds, you can also use the `reverseRouting` parameter instead.
        - `amount` object: The amount that will be pulled back.
          - `currency` string, required: A three-character ISO 4217 currency code.
          - `value` string, required: A string containing an exact monetary amount in the given currency.
        - `source` object: Where the funds will be pulled back from.
          - `type` string: The type of source. Currently only the source type `organization` is supported. Possible values: `organization`
          - `organizationId` string: Required for source type `organization`. The ID of the connected organization the funds should be pulled back from.
      - `testmode` boolean, nullable: Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
      - `_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.
        - `payment` object, required: The API resource URL of the [payment](get-payment) that this refund belongs to.
          - `href` string, required: The actual URL string.
          - `type` string, required: The content type of the page or endpoint the URL points to.
        - `settlement` object, nullable: The API resource URL of the [settlement](get-settlement) this refund has been settled with. Not present if not yet settled.
          - `href` string: The actual URL string.
          - `type` string: The content type of the page or endpoint the URL points to.
  - `_links` object, required: Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
    - `self` object, required: The URL to the current set of items.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `previous` object, nullable, required: The previous set of items, if available.
      - `href` string: The actual URL string.
      - `type` string: The content type of the page or endpoint the URL points to.
    - `next` object, nullable, required: The next set of items, if available.
      - `href` string: The actual URL string.
      - `type` string: The content type of the page or endpoint the URL points to.
    - `documentation` 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.

## Other responses

- `400`: The request contains issues. For example, if the specified `from` value is not a valid ID.
- `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)