PaymentLinkResponse.md

PaymentLinkResponse

Fields

Field	Type	Required	Description	Example
resource	String	✔️	Indicates the response contains a payment link object. Will always contain the string payment-link for this endpoint.	payment-link
id	String	✔️	The identifier uniquely referring to this payment link. Example: pl_4Y0eZitmBnQ6IDoMqZQKh.	pl_d9fQur83kFdhH8hIhaZfq
mode	Mode	✔️	Whether this entity was created in live mode or in test mode.	live
description	String	✔️	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.	Chess Board
amount	Optional<AmountNullable>	✔️	In v2 endpoints, monetary amounts are represented as objects with a currency and value field.
minimumAmount	JsonNullable<AmountNullable>	➖	In v2 endpoints, monetary amounts are represented as objects with a currency and value field.
archived	boolean	✔️	Whether the payment link is archived. Customers will not be able to complete payments on archived payment links.	false
redirectUrl	Optional<String>	✔️	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.	https://webshop.example.org/payment-links/redirect/
webhookUrl	Optional<String>	✔️	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.	https://webshop.example.org/payment-links/webhook/
lines	List<PaymentLineItemResponse>	➖	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.
billingAddress	Optional<PaymentAddress>	➖	N/A
shippingAddress	Optional<PaymentAddress>	➖	N/A
profileId	Optional<String>	✔️	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.	pfl_QkEhN94Ba
reusable	Optional<Boolean>	✔️	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.	false
createdAt	String	✔️	The entity's date and time of creation, in ISO 8601 format.	2024-03-20T09:13:37+00:00
paidAt	Optional<String>	✔️	The date and time the payment link became paid, in ISO 8601 format.	2025-12-24T11:00:16+00:00
expiresAt	Optional<String>	✔️	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.	2025-12-24T11:00:16+00:00
allowedMethods	List<PaymentLinkMethodResponse>	✔️	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.
applicationFee	Optional<PaymentLinkResponseApplicationFee>	➖	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.
sequenceType	Optional<PaymentLinkSequenceTypeResponse>	➖	N/A	oneoff
customerId	JsonNullable<String>	➖	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.	cst_XimFHuaEzd
links	PaymentLinkResponseLinks	✔️	An object with several relevant URLs. Every URL object will contain an href and a type field.