create-payment-link.rst

Create payment link

Payment links API

With the Payment Links API you can generate payment links that by default, unlike regular payments, do not expire. The Payment Link can be shared with your customers and will redirect them to them the payment page where they can complete the payment. A /reference/v2/payments-api/get-payment will only be created once the customer initiates the payment.

Parameters

description string	This description will also be used as the payment description and will be shown to your customer on their card or bank statement when possible.
amount amount object	The amount that you want to charge, e.g. {"currency":"EUR", "value":"1000.00"} if you would want to charge €1000.00. currency string An ISO 4217 currency code. The currencies supported </payments/multicurrency> depend on the payment methods that are enabled on your account. value string A string containing the exact amount you want to charge in the given currency. Make sure to send the right amount of decimals and omit the thousands separator. Non-string values are not accepted.
redirectUrl string	The URL your customer will be redirected to after completing the payment process.
webhookUrl string	Set the webhook URL, where we will send payment link status updates to. Note The webhookUrl is optional, but without a webhook you will miss out on important status changes about your payment link. The webhookUrl must be reachable from Mollie's point of view, so you cannot use localhost. If you want to use webhook during development on localhost, you must use a tool like ngrok to have the webhooks delivered to your local machine.
expiresAt datetime	The expiry date of the payment link in ISO 8601 format. For example: 2021-12-24T12:00:16+01:00. It will always be stored in UTC timezone.

Access token parameters

If you are using organization access tokens </guides/authentication> or are creating an OAuth app </oauth/overview>, the only mandatory extra parameter is the profileId parameter. With it, you can specify which profile the payment belongs to. Organizations can have multiple profiles for each of their websites. See Profiles API </reference/v2/profiles-api/get-profile> for more information.

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

Response

201 application/hal+json

A payment link object is returned, as described in /reference/v2/payment-links-api/get-payment-link.

Example

.. code-block:: bash

curl -X POST https://api.mollie.com/v2/payment-links -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" -d "amount[currency]=EUR" -d "amount[value]=24.95" -d "description=Bicycle tires" -d "expiresAt=2021-06-06T11:00:00+00:00" -d "redirectUrl=https://webshop.example.org/thanks" -d "webhookUrl=https://webshop.example.org/payment-links/webhook/"

Response

HTTP/1.1 201 Created
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": null,
    "updatedAt": null,
    "expiresAt": "2021-06-06T11:00:00+00:00",
    "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/create-payment-link",
            "type": "text/html"
        }
    }
}