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:
Unique identifier of the company account.
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:
Your description for this webhook configuration.
Shows how merchant accounts are filtered when configuring the webhook.
Possible values:
filterMerchantAccounts
.filterMerchantAccounts
.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:
Not needed for filterMerchantAccountType
: allAccounts.
Network type for Terminal API notification webhooks. Possible values:
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:
If not specified, the webhook will use sslVersion
: TLSv1.2.
The type of webhook that is being created. Possible values are:
Find out more about standard notification webhooks and other types of notifications.
Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.
Username to access the webhook URL.
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.