• docs
  • Developers
  • Support
  • Log in
  • Sign up
  • Dashboard
  • Overview
  • Payments
  • Connect
  • API reference
  • Changelog
  • Overview

    Mollie API

    • Overview
    • Security
    • Authentication
    • Testing
    • Common data types
    • Handling errors
    • Webhooks
    • Pagination
    • API idempotency

    Mobile apps

    • Overview
    • Accepting payments
    • Authorizing Mollie users

    Integration partners

    • Getting started
    • User agent strings
  • Payments

    Payments

    • Accepting payments
    • Hosted checkout
    • Build your own checkout
    • Status changes
    • Refunds
    • Recurring payments
    • Multicurrency
    • QR codes
    • Integrating gift cards
    • Migrating from v1 to v2

    Orders

    • Overview
    • Why use orders?
    • Migrating to the Orders API
    • Handling discounts
    • Status changes
    • Integrating vouchers
    • Integrating PayPal Express Checkout button

    Wallets

    • Apple Pay overview
    • Direct integration of Apple Pay

    Mollie Components

    • Overview
    • Testing
    • Handling errors
    • Styling
  • Connect

    Mollie Connect

    • Overview
    • Onboard your customers
    • Application fees
    • Splitting payments
    • Refunds and chargebacks

    Creating an app

    • Getting started
    • Permissions
  • API reference

    Accepting payments

    • Payments API
    • Methods API
    • Refunds API
    • Chargebacks API
    • Captures API
    • Wallets API
    • Payment links API
      • Create payment link
      • Get payment link
      • List payment links

    Components

    • Mollie.js

    Receiving orders

    • Orders API
    • Shipments API

    Recurring

    • Customers API
    • Mandates API
    • Subscriptions API

    Connect

    • OAuth API
    • Permissions API
    • Organizations API
    • Profiles API
    • Onboarding API

    Business operations

    • Balances API BETA
    • Settlements API
    • Invoices API

    Partners

    • Clients API
  • Changelog

    Timeline

    • Get payment link
      • Parameters
      • Response
      • Example
        • Response

Accepting payments

  • Payments API
  • Methods API
  • Refunds API
  • Chargebacks API
  • Captures API
  • Wallets API
  • Payment links API
    • Create payment link
    • Get payment link
    • List payment links

Components

  • Mollie.js

Receiving orders

  • Orders API
  • Shipments API

Recurring

  • Customers API
  • Mandates API
  • Subscriptions API

Connect

  • OAuth API
  • Permissions API
  • Organizations API
  • Profiles API
  • Onboarding API

Business operations

  • Balances API BETA
  • Settlements API
  • Invoices API

Partners

  • Clients API

Get payment link¶

Payment links API v2
GEThttps://api.mollie.com/v2/payment-links/*id*
Authentication:API keysOrganization access tokensApp access tokens

Retrieve a single payment link object by its token.

Parameters¶

Replace id in the endpoint URL by the payment link’s ID, for example pl_4Y0eZitmBnQ6IDoMqZQKh.

Response¶

200 application/hal+json

resourcestring
Indicates the response contains a payment link object. Will always contain payment-link for this endpoint.
idstring
The identifier uniquely referring to this payment link. Mollie assigns this identifier at creation time. For example pl_4Y0eZitmBnQ6IDoMqZQKh. Its ID will always be used by Mollie to refer to a certain payment link.
descriptionstring
A short description of the payment link. The description is visible in the Dashboard and will be shown on the customer’s bank or card statement when possible. This description will eventual been used as payment description.
modestring

The mode used to create this payment link. Mode determines whether a payment link is real (live mode) or a test payment link.

Possible values: live test

profileIdstring
The identifier referring to the profile this payment link was created on. For example, pfl_QkEhN94Ba.
amountamount object

The amount of the payment link, e.g. {"currency":"EUR", "value":"100.00"} for a €100.00 payment link.

Show child parameters

currencystring
The ISO 4217 currency code.
valuestring
A string containing the exact amount of the payment link in the given currency.
archivedboolean
Whether the payment link is archived. Customers will not be able to complete payments on archived payment links.
redirectUrlstring
The URL your customer will be redirected to after completing the payment process.
webhookUrlstringoptional
The URL Mollie will call as soon an important status change takes place.
createdAtdatetime
The payment link’s date and time of creation, in ISO 8601 format.
paidAtdatetimeoptional
The date and time the payment link became paid, in ISO 8601 format.
updatedAtdatetimeoptional
The date and time the payment link last status change, in ISO 8601 format.
expiresAtdatetimeoptional
The expiry date and time of the payment link, in ISO 8601 format.
_linksobject

An object with several URL objects relevant to the payment link. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of the payment link itself.
paymentLinkURL object
Direct link to the payment link.
documentationURL object
The URL to the payment link retrieval endpoint documentation.

Example¶

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/payment-links/pl_4Y0eZitmBnQ6IDoMqZQKh \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");
$paymentLink = $mollie->paymentLinks->get("pl_4Y0eZitmBnQ6IDoMqZQKh");
1
2
3
4
5
6
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_api_key("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM")

payment_link = mollie_client.payment_links.get("pl_4Y0eZitmBnQ6IDoMqZQKh")
1
2
3
4
We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to share suggestions on our Discord:
https://discord.gg/VaTVkXB4aQ
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to share suggestions on our Discord:
https://discord.gg/VaTVkXB4aQ

Response¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "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"
    },
    "archived": false,
    "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://paymentlink.mollie.com/payment/4Y0eZitmBnQ6IDoMqZQKh/",
            "type": "text/html"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/payment-links-api/get-payment-link",
            "type": "text/html"
        }
    }
}
Was this page helpful? Feel free to share your feedback with us directly on our Discord.