API Reference
Start typing to search…

Create payment link

post
https://api.mollie.com/v2/payment-links

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 payment will only be created once the customer initiates the payment.

Access with

API key

Organization access token with payment-links.write

OAuth access with payment-links.write

Body Params
string
required
length ≤ 255

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.

amount
object | null

The amount of the payment link. If no amount is provided initially, the customer will be prompted to enter an amount.

minimumAmount
object | null

The minimum amount of the payment link. This property is only allowed when there is no amount provided. The customer will be prompted to enter a value greater than or equal to the minimum amount.

string | null

The URL your customer will be redirected to after completing the payment process. If no redirect URL is provided, the customer will be shown a generic message after completing the payment.

string | null

The webhook URL where we will send payment status updates to.

The webhookUrl is optional, but without a webhook you will miss out on important status changes to any payments resulting from the 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.

lines
array of objects | null

Optionally provide the order lines for the payment. Each line contains details such as a description of the item ordered and its price.

All lines must have the same currency as the payment.

Required for payment methods billie, in3, klarna, riverty and voucher.

lines
billingAddress
object

The customer's billing address details. We advise to provide these details to improve fraud protection and conversion.

Should include email or a valid postal address consisting of streetAndNumber, postalCode, city and country.

Required for payment method in3, klarna, billie and riverty.

shippingAddress
object

The customer's shipping address details. We advise to provide these details to improve fraud protection and conversion.

Should include email or a valid postal address consisting of streetAndNumber, postalCode, city and country.

string | null

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId must not be sent in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

boolean | null
Defaults to false

Indicates whether the payment link is reusable. If this field is set to true, customers can make multiple payments using the same link.

If no value is specified, the field defaults to false, allowing only a single payment per link.

string | null

The date and time the payment link is set to expire, in ISO 8601 format. If no expiry date was provided up front, the payment link will not expire automatically.

allowedMethods
array of strings | null

An array of payment methods that are allowed to be used for this payment link. When this parameter is not provided or is an empty array, all enabled payment methods will be available.

Possible values: applepay bacs bancomatpay bancontact banktransfer belfius billie blik creditcard eps giftcard ideal in3 kbc klarna mbway multibanco mybank paybybank paypal paysafecard pointofsale przelewy24 riverty satispay swish trustly twint voucher

allowedMethods
applicationFee
object

With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie merchants.

If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this applicationFee parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent to your own account balance.

string

If set to first, a payment mandate is established right after a payment is made by the customer.

Defaults to oneoff, which is a regular payment link and will not establish a mandate after payment.

The mandate ID can be retrieved by making a call to the Payment Link Payments Endpoint.

Possible values: oneoff first

string | null

Only relevant when sequenceType is set to first

The ID of the customer the payment link is being created for. If a value is not provided, the customer will be required to input relevant information which will be used to establish a mandate after the payment is made.

boolean | null

Whether to create the entity in test mode or live mode.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Responses

Updated 14 days ago

Language
Credentials
Request
Response 
 Choose an example:
application/hal+json
Updated 14 days ago