List payment links

Payment links API v2

GEThttps://api.mollie.com/v2/payment-links

Authentication:API keysOrganization access tokensApp access tokens

Retrieve all payments links created with the current website profile, ordered from newest to oldest.

The results are paginated. See pagination for more information.

Parameters

from string optional	Used for pagination. Offset the result set to the payment link with this ID. The payment link with this ID is included in the result set as well.
limit integer optional	The number of payment links to return (with a maximum of 250).

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the following query string parameters are also available. With the profileId parameter, you can specify which profile you want to look at when listing payment links. If you omit the profileId parameter, you will get all payment links on the organization. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

profileId string optional	The website profile’s unique identifier, for example pfl_3RkSN1zuPE.
testmode boolean optional	Set this to true to only retrieve payment links made in test mode. By default, only live payment links are returned.

Response

200 application/hal+json

count integer	The number of payment links found in _embedded, which is either the requested number (with a maximum of 250) or the default number.
_embedded object	The object containing the queried data. paymentLinks array An array of payment link objects as described in Get payment link.
_links object	Links to help navigate through the lists of payment links. Every URL object will contain an href and a type field. self URL object The URL to the current set of payment links. previous URL object The previous set of payment links, if available. next URL object The next set of payment links, if available. documentation URL object The URL to the payment links list endpoint documentation.

Example

cURLPHPPythonRubyNode.js

curl -X GET https://api.mollie.com/v2/payment-links?limit=5 \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

We don't have a PHP code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

We don't have a Python code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 5,
    "_embedded": {
        "payment_links": [
              {
                  "resource": "payment-link",
                  "id": "pl_4Y0eZitmBnQ6IDoMqZQKh",
                  "mode": "test",
                  "profileId": "pfl_QkEhN94Ba",
                  "createdAt": "2021-03-20T09:13:37+00:00",
                  "paidAt": "2021-03-21T09:13:37+00:00",
                  "updatedAt": "2021-03-21T09:13:37+00:00",
                  "expiresAt": null,
                  "amount": {
                      "value": "24.95",
                      "currency": "EUR"
                  },
                  "description": "Bicycle tires",
                  "redirectUrl": "https://webshop.example.org/thanks",
                  "webhookUrl": "https://webshop.example.org/payment-links/webhook/",
                  "_links": {
                      "self": {
                          "href": "https://api.mollie.com/v2/payment-links/pl_4Y0eZitmBnQ6IDoMqZQKh",
                          "type": "application/json"
                      },
                      "paymentLink": {
                          "href": "https://useplink.com/payment/4Y0eZitmBnQ6IDoMqZQKh/",
                          "type": "text/html"
                      },
                      "documentation": {
                          "href": "https://docs.mollie.com/reference/v2/payment-links-api/get-payment-link",
                          "type": "text/html"
                      }
                  }
              },
            { },
            { },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/payment-links?limit=5",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/payment-links?from=pl_ER6aqfpXg6nZrJvcsxNsm&limit=5",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/payment-links-api/list-payment-links",
            "type": "text/html"
        }
    }
}