Set up a webhook


Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure.

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

  • Management API—Webhooks read and write
Endpoint destination URL{companyId}/webhooks
Click to copy

Path Parameters


Unique identifier of the company account.

Request Parameters


Indicates if expired SSL certificates are accepted. Default value: false.


Indicates if self-signed SSL certificates are accepted. Default value: false.


Indicates if untrusted SSL certificates are accepted. Default value: false.


Indicates if the webhook configuration is active. The field must be true for us to send webhooks about events related an account.


Additional shopper and transaction information to be included in your standard notifications. Find out more about the available additional settings.


Format or protocol for receiving webhooks. Possible values:

  • soap
  • http
  • json

Your description for this webhook configuration.


Shows how merchant accounts are filtered when configuring the webhook.

Possible values:

  • allAccounts : Includes all merchant accounts, and does not require specifying filterMerchantAccounts.
  • includeAccounts : The webhook is configured for the merchant accounts listed in filterMerchantAccounts.
  • excludeAccounts : The webhook is not configured for the merchant accounts listed in filterMerchantAccounts.

A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for filterMerchantAccountType.

Required if filterMerchantAccountType is either:

  • includeAccounts
  • excludeAccounts

Not needed for filterMerchantAccountType: allAccounts.


Network type for Terminal API notification webhooks. Possible values:

  • public
  • local

Default Value: public.


Password to access the webhook URL.


Indicates if the SOAP action header needs to be populated. Default value: false.

Only applies if communicationFormat: soap.


SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

If not specified, the webhook will use sslVersion: TLSv1.2.


The type of webhook that is being created. Possible values are:

  • standard
  • account-settings-notification
  • banktransfer-notification
  • boletobancario-notification
  • directdebit-notification
  • ach-notification-of-change-notification
  • pending-notification
  • ideal-notification
  • ideal-pending-notification
  • report-notification
  • rreq-notification

Find out more about standard notification webhooks and other types of notifications.


Public URL where webhooks will be sent, for example

Max length: 255

Username to access the webhook URL.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less