This API supports webhooks. When asynchronous events occur on our side, we can send an HTTP call (webhook) to your application, so you can react to these events in real time.
You can set up webhooks via the dashboard. See the Next-gen Webhooks guide.
The payload of a webhook is always simply a snapshot of the entity, as returned by the GET endpoint.
If you are setting up webhooks via the Webhooks API instead for any of the events below, you will need access to payment-links.read.
Available webhook events
| Event | Description |
|---|---|
payment-link.paid | A payment link moved to the paid status. |
Webhook payload examples
{
"resource": "payment-link",
"id": "pl_4Y0eZitmBnQ6IDoMqZQKh",
"mode": "live",
"description": "Bicycle tires",
"amount": {
"currency": "EUR",
"value": "24.95"
},
"archived": false,
"redirectUrl": "https://webshop.example.org/thanks",
"webhookUrl": "https://webshop.example.org/payment-links/webhook",
"profileId": "pfl_QkEhN94Ba",
"createdAt": "2021-03-20T09:29:56+00:00",
"paidAt": "2022-03-20T09:29:56+00:00",
"expiresAt": "2023-06-06T11:00:00+00:00",
"reusable": false,
"allowedMethods": ["ideal"],
"sequenceType": "oneoff",
"customerId": null,
"_links": {
"self": {
"href": "https://api.mollie.com/v2/payment-links/pl_4Y0eZitmBnQ6IDoMqZQKh",
"type": "application/hal+json"
},
"paymentLink": {
"href": "https://payment-links.mollie.com/payment/4Y0eZitmBnQ6IDoMqZQKh",
"type": "text/html"
},
"documentation": {
"href": "https://docs.mollie.com/reference/get-payment-link",
"type": "text/html"
}
}
}