Webhooks for the Payouts 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 payouts.read.

Available webhook events

Event	Description
`payout.canceled`	A payout was canceled before it could be processed.
`payout.completed`	A payout has been successfully transferred to the merchant's bank account.
`payout.failed`	A payout could not be completed due to an error.
`payout.initiated`	A payout has been initiated and is being processed.
`payout.processing-at-bank`	A payout has been submitted to the bank and is awaiting settlement.

Webhook payload examples

{
  "resource": "payout",
  "id": "payout_j8NvRAM2WNZtsykpLEX8J",
  "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "My payout description",
  "status": "canceled",
  "statusReason": {
    "code": "canceled",
    "message": "The payout has been canceled."
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "initiatedAt": null,
  "completedAt": null,
  "canceledAt": "2024-03-20T15:00:00+00:00",
  "mode": "live",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payouts/payout_j8NvRAM2WNZtsykpLEX8J",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-payout",
      "type": "text/html"
    }
  }
}

{
  "resource": "payout",
  "id": "payout_j8NvRAM2WNZtsykpLEX8J",
  "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "My payout description",
  "status": "completed",
  "statusReason": {
    "code": "completed",
    "message": "The payout has been completed successfully."
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "initiatedAt": "2024-03-21T06:00:01+00:00",
  "completedAt": "2024-03-21T10:30:00+00:00",
  "canceledAt": null,
  "mode": "live",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payouts/payout_j8NvRAM2WNZtsykpLEX8J",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-payout",
      "type": "text/html"
    }
  }
}

{
  "resource": "payout",
  "id": "payout_j8NvRAM2WNZtsykpLEX8J",
  "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "My payout description",
  "status": "failed",
  "statusReason": {
    "code": "insufficient_funds",
    "message": "Insufficient funds on the balance to complete the payout."
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "initiatedAt": "2024-03-21T06:00:01+00:00",
  "completedAt": null,
  "canceledAt": null,
  "mode": "live",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payouts/payout_j8NvRAM2WNZtsykpLEX8J",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-payout",
      "type": "text/html"
    }
  }
}

{
  "resource": "payout",
  "id": "payout_j8NvRAM2WNZtsykpLEX8J",
  "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "My payout description",
  "status": "initiated",
  "statusReason": {
    "code": "initiated",
    "message": "The payout has been initiated."
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "initiatedAt": "2024-03-21T06:00:01+00:00",
  "completedAt": null,
  "canceledAt": null,
  "mode": "live",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payouts/payout_j8NvRAM2WNZtsykpLEX8J",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-payout",
      "type": "text/html"
    }
  }
}

{
  "resource": "payout",
  "id": "payout_j8NvRAM2WNZtsykpLEX8J",
  "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "My payout description",
  "status": "processing-at-bank",
  "statusReason": {
    "code": "processing_at_bank",
    "message": "The payout is being processed by the bank."
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "initiatedAt": "2024-03-21T06:00:01+00:00",
  "completedAt": null,
  "canceledAt": null,
  "mode": "live",
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/payouts/payout_j8NvRAM2WNZtsykpLEX8J",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-payout",
      "type": "text/html"
    }
  }
}