Webhooks

Create a webhook

Changed on Nov 3, 2026

post/webhooks

Request

The document declares no server URL.
Auth
none declared. Required headers: ApiKey, MerchantId, Environment

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Request body

urlstring required

Fully qualified url, starting with https://, of the webhook endpoint.

eventsstring[] required

The list of events to enable for this endpoint.

descriptionstring

An optional description of what the webhook is used for.

metadataobject

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Example request

{
  "url": "https://my.webhook.target",
  "events": [
    "payment.created",
    "payment_intent.created"
  ],
  "description": "This is a webhook trigger upon payment & payment_intent creation",
  "metadata": {}
}

Response

idstring required

Unique identifier for the Webhook

createdAtstring required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

updatedAtstring required

Datetime in UTC timezone at which this object was updated. Follows the Datetime ISO.

mode'live' | 'sandbox' required

Mode in which this Webhook exists. The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode. The live mode has to be used to make real transactions.

descriptionstring

An optional description of what the webhook is used for.

eventsstring[] required

The list of events to enable for this endpoint.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

secretstring

The endpoint’s secret, used to generate webhook signatures. Only returned at creation.

status'enabled' | 'disabled' required

The webhook status

urlstring required

Fully qualified url of the webhook endpoint.

Example response

{
  "id": "wh_z1urYtVFgEebtcj8fxp4v",
  "createdAt": "2020-10-15T12:09:49.355Z",
  "updatedAt": "2020-10-15T12:09:49.355Z",
  "mode": "live",
  "description": "This is a webhook trigger upon payment & payment_intent creation",
  "events": [
    "payment.created",
    "payment_intent.created"
  ],
  "metadata": {},
  "secret": "5257a869e7ecebeda32affa62cd...",
  "status": "enabled",
  "url": "https://my.webhook.target"
}

Changes

Nov 3, 2026f6d3f87df5e0 Revision changes
- info
  added the new bill_payment.collected enum value to the request property /
- info
  added the new bill_payment.settlement_failed enum value to the request property /
- info
  added the new bill_payment.succeeded enum value to the request property /
- info
  added the new cross_border_transaction.cancelled enum value to the request property /
- info
  added the new cross_border_transaction.compliance_review enum value to the request property /
- info
  added the new cross_border_transaction.created enum value to the request property /
- info
  added the new cross_border_transaction.failed enum value to the request property /
- info
  added the new cross_border_transaction.pending enum value to the request property /
- info
  added the new cross_border_transaction.pending_manual enum value to the request property /
- info
  added the new cross_border_transaction.successful enum value to the request property /
- info
  added the new sender.approved enum value to the request property /
- info
  added the new sender.created enum value to the request property /
- info
  added the new sender.disabled enum value to the request property /
- info
  added the new sender.rejected enum value to the request property /
- info
  added the new sender.review_required enum value to the request property /
- info
  added the new settlement_request.confirmed enum value to the request property /
- info
  added the new settlement_request.funds_sent enum value to the request property /
- info
  added the new settlement_request.processing enum value to the request property /
- info
  added the new settlement_request.rejected enum value to the request property /
- info
  added the new settlement_request.submitted enum value to the request property /
- info
  added the new subscription.cancelled enum value to the request property /
- info
  added the new subscription.created enum value to the request property /
- info
  added the new subscription.suspended enum value to the request property /

Operation history