Set up a webhook
Subscribe to receive webhook notifications about events related to your merchant 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
The unique identifier of the merchant 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.
Format or protocol for receiving webhooks. Possible values:
Your description for this webhook configuration.
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:
- HTTP - Only allowed on Test environment.
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.
200 - OK
The request has succeeded.Show more
204 - No Content
The request has been successfully processed, but there is no additional content.
400 - Bad Request
A problem reading or understanding the request.Show more
401 - Unauthorized
Authentication required.Show more
403 - Forbidden
Insufficient permissions to process the request.Show more
422 - Unprocessable Entity
A request validation error.Show more
500 - Internal Server Error
The server could not process the request.Show more