MOmollie
Refunds API

List all refunds

Changed on

Retrieve a list of all of your refunds.

The results are paginated.

🔑 Access with

API key

Advanced access token with refunds.read

OAuth access with refunds.read

get/refunds

Request

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

Query parameters

fromstring
Example:re_5B8cwPMGnU

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.

sortstring
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

embed'payment'
Example:payment

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

profileIdstring

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

Example:pfl_5B8cwPMGnU

The identifier referring to the profile you wish to retrieve the resources for.

Most API credentials are linked to a single profile. In these cases the profileId must not be sent. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

A list of refund objects

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": {
    "refunds": [
      {
        "resource": "refund",
        "id": "re_5B8cwPMGnU",
        "mode": "live",
        "description": "Refunding a Chess Board",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "settlementAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "paymentId": "tr_5B8cwPMGnU",
        "settlementId": "stl_5B8cwPMGnU",
        "status": "queued",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "externalReference": {
          "type": "acquirer-reference"
        },
        "routingReversals": [
          {
            "amount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "source": {
              "type": "organization",
              "organizationId": "org_1234567"
            }
          }
        ],
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "payment": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "settlement": {
            "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

  • 64fc448adebbRevision changes
    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      removed the optional write-only property _embedded/refunds/items/reverseRouting from the response with the status

    • info

      removed the optional write-only property _embedded/refunds/items/testmode from the response with the status

    • info

      added subschema #1 to the // response property allOf list for the response status