Payment Links API

List payment links

Changed on Nov 3, 2026

Retrieve a list of all payment links.

The results are paginated.

🔑 Access with

API key

Advanced access token with payment-links.read

OAuth access with payment-links.read

get/payment-links

Request

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

Query parameters

fromstring

Example:pl_d9fQur83kFdhH8hIhaZfq

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.

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 payment link 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": {
    "payment_links": [
      {
        "id": "pl_d9fQur83kFdhH8hIhaZfq",
        "mode": "live",
        "description": "Chess Board",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "minimumAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "redirectUrl": "https://webshop.example.org/payment-links/redirect/",
        "webhookUrl": "https://webshop.example.org/payment-links/webhook/",
        "lines": [
          {
            "type": "physical",
            "description": "LEGO 4440 Forest Police Station",
            "quantity": 1,
            "quantityUnit": "pcs",
            "unitPrice": {
              "currency": "EUR",
              "value": "10.00"
            },
            "discountAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "totalAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "vatRate": "21.00",
            "vatAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "sku": "9780241661628",
            "categories": [
              "meal",
              "eco"
            ],
            "imageUrl": "https://...",
            "productUrl": "https://..."
          }
        ],
        "billingAddress": {
          "title": "Mr.",
          "givenName": "Piet",
          "familyName": "Mondriaan",
          "organizationName": "Mollie B.V.",
          "streetAndNumber": "Keizersgracht 126",
          "streetAdditional": "Apt. 1",
          "postalCode": "1234AB",
          "email": "piet@example.org",
          "city": "Amsterdam",
          "region": "Noord-Holland",
          "country": "NL"
        },
        "shippingAddress": {
          "title": "Mr.",
          "givenName": "Piet",
          "familyName": "Mondriaan",
          "organizationName": "Mollie B.V.",
          "streetAndNumber": "Keizersgracht 126",
          "streetAdditional": "Apt. 1",
          "postalCode": "1234AB",
          "email": "piet@example.org",
          "city": "Amsterdam",
          "region": "Noord-Holland",
          "country": "NL"
        },
        "profileId": "pfl_QkEhN94Ba",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "paidAt": "2025-12-24T11:00:16+00:00",
        "expiresAt": "2025-12-24T11:00:16+00:00",
        "allowedMethods": [
          "ideal"
        ],
        "applicationFee": {
          "amount": {
            "currency": "EUR",
            "value": "10.00"
          },
          "description": "Platform fee"
        },
        "sequenceType": "oneoff",
        "customerId": "cst_XimFHuaEzd",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "paymentLink": {
            "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

Nov 3, 202664fc448adebb Revision changes
- warning
  added the new googlepay enum value to the ///// response property for the response status
- warning
  added the new wero enum value to the ///// response property for the response status

Operation history