Payment Links API
Create payment link
Changed onWith 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 payment will only be created once the customer initiates the payment.
post/v2/payment-links
Request
- Base URLhttps://api.mollie.com
- URLhttps://api.mollie.com/v2/payment-links
- Auth
- HTTP bearer
- or HTTP bearer
- or OAuth 2Authorization code: https://my.mollie.com/oauth2/authorizeToken URL: https://api.mollie.com/oauth2/tokens scopes: payment-links.write
Headers
idempotency-keystring
Example:123e4567-e89b-12d3-a456-426
A unique key to ensure idempotent requests. This key should be a UUID v4 string.
Request body
Example request
{
"resource": "payment-link",
"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"
}
}
}Response
The newly created payment link object.
Example response
{
"resource": "payment-link",
"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"
}
}
}Changes
- warning
added the new
googlepayenum value to the/////response property for the response status - info
added the new
googlepayenum value to the request property/
- warning
- warning
added the new
weroenum value to the/////response property for the response status - info
added the new
weroenum value to the request property/
- warning