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:
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.
Format or protocol for receiving webhooks. Possible values:
Your description for this webhook configuration.
Shows how merchant accounts are filtered when configuring the webhook.
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 is either:
Not needed for
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
SSL version to access the public webhook URL specified in the
url field. Possible values:
If not specified, the webhook will use
The type of webhook that is being created. Possible values are:
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.
The request has succeeded.Show more
A problem reading or understanding the request.Show more
Authentication required.Show more
Insufficient permissions to process the request.Show more
A request validation error.Show more
The server could not process the request.Show more