Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Webhooks - company level

Test a webhook

Sends sample notifications to test if the webhook is set up correctly.

We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the merchantIds array to specify a subset of the merchant accounts for which to send test notifications.

We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.

The response describes the result of the test. The status field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests.

To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
post/companies/{companyId}/webhooks/{webhookId}/test

Path parameters

companyIdstring required

The unique identifier of the company account.

webhookIdstring required

Unique identifier of the webhook configuration.

Request body

merchantIdsstring[]

List of merchantId values for which test webhooks will be sent. The list can have a maximum of 20 merchantId values.

If not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.

typesstring[]

List of event codes for which to send test notifications. Only the webhook types below are supported.

Possible values if webhook type: standard:

  • AUTHORISATION
  • CHARGEBACK_REVERSED
  • ORDER_CLOSED
  • ORDER_OPENED
  • PAIDOUT_REVERSED
  • PAYOUT_THIRDPARTY
  • REFUNDED_REVERSED
  • REFUND_WITH_DATA
  • REPORT_AVAILABLE
  • CUSTOM - set your custom notification fields in the notification object.

Possible values if webhook type: banktransfer-notification:

  • PENDING

Possible values if webhook type: report-notification:

  • REPORT_AVAILABLE

Possible values if webhook type: ideal-notification:

  • AUTHORISATION

Possible values if webhook type: pending-notification:

  • PENDING

Response

OK - the request has succeeded.

Example response

{
  "data": [
    {
      "responseCode": "200"
    }
  ]
}