Webhooks for the Refunds API

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 payments.read.

Available webhook events

Event	Description
`refund.canceled`	A refund was canceled before processing.
`refund.failed`	A refund could not be completed.
`refund.pending`	A refund is pending and awaiting bank confirmation.
`refund.processing`	A refund is being processed by the bank.
`refund.queued`	A refund has been accepted and is queued for processing.
`refund.refunded`	A refund has been transferred to your customer.

Webhook payload examples

{
  "resource": "refund",
  "id": "re_4qqhO89gsT",
  "mode": "live",
  "amount": { "currency": "EUR", "value": "5.95" },
  "description": "Order #12345",
  "metadata": null,
  "status": "canceled",
  "paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo/refunds/re_4qqhO89gsT",
      "type": "application/hal+json"
    },
    "payment": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-refund",
      "type": "text/html"
    }
  }
}

{
  "resource": "refund",
  "id": "re_4qqhO89gsT",
  "mode": "live",
  "amount": { "currency": "EUR", "value": "5.95" },
  "description": "Order #12345",
  "metadata": null,
  "status": "failed",
  "paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo/refunds/re_4qqhO89gsT",
      "type": "application/hal+json"
    },
    "payment": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-refund",
      "type": "text/html"
    }
  }
}

{
  "resource": "refund",
  "id": "re_4qqhO89gsT",
  "mode": "live",
  "amount": { "currency": "EUR", "value": "5.95" },
  "description": "Order #12345",
  "metadata": null,
  "status": "pending",
  "paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo/refunds/re_4qqhO89gsT",
      "type": "application/hal+json"
    },
    "payment": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-refund",
      "type": "text/html"
    }
  }
}

{
  "resource": "refund",
  "id": "re_4qqhO89gsT",
  "mode": "live",
  "amount": { "currency": "EUR", "value": "5.95" },
  "description": "Order #12345",
  "metadata": null,
  "status": "processing",
  "paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo/refunds/re_4qqhO89gsT",
      "type": "application/hal+json"
    },
    "payment": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-refund",
      "type": "text/html"
    }
  }
}

{
  "resource": "refund",
  "id": "re_4qqhO89gsT",
  "mode": "live",
  "amount": { "currency": "EUR", "value": "5.95" },
  "description": "Order #12345",
  "metadata": null,
  "status": "queued",
  "paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo/refunds/re_4qqhO89gsT",
      "type": "application/hal+json"
    },
    "payment": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-refund",
      "type": "text/html"
    }
  }
}

{
  "resource": "refund",
  "id": "re_4qqhO89gsT",
  "mode": "live",
  "amount": { "currency": "EUR", "value": "5.95" },
  "settlementAmount": { "currency": "EUR", "value": "-5.95" },
  "description": "Order #12345",
  "metadata": null,
  "status": "refunded",
  "paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo/refunds/re_4qqhO89gsT",
      "type": "application/hal+json"
    },
    "payment": {
      "href": "https://api.mollie.com/v2/payments/tr_5B8cwPMGnU6qLbRvo7qEZo",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-refund",
      "type": "text/html"
    }
  }
}