Set up a webhook

HTTP Responses

• 200 - OK

  The request has succeeded.

  Show more Show less

  _links object

  References to resources connected with this webhook.

  Show children Hide children

  company object

  The company account that the webhook is configured for. Only present for company-level webhooks.

  Show children Hide children

  href string

  generateHmac object

  Generate an HMAC key.

  Show children Hide children

  href string

  merchant object

  The merchant account that the webhook is configured for. Only present for merchant-level webhooks.

  Show children Hide children

  href string

  self object

  Link to the resource itself.

  Show children Hide children

  href string

  testWebhook object

  Test the webhook setup.

  Show children Hide children

  href string

  acceptsExpiredCertificate boolean

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

  acceptsSelfSignedCertificate boolean

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

  acceptsUntrustedRootCertificate boolean

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

  accountReference string

  Reference to the account the webook is set on.

  active boolean

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

  additionalSettings object

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

  Show children Hide children

  excludeEventCodes array [string]

  Object containing list of event codes for which the notifcation will not be sent.

  includeEventCodes array [string]

  Object containing list of event codes for which the notifcation will be sent.

  properties object

  Object containing boolean key-value pairs. The key can be any standard webhook additional setting, and the value indicates if the setting is enabled. For example, captureDelayHours: true means the standard notifications you get will contain the number of hours remaining until the payment will be captured.

  certificateAlias string

  The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.

  communicationFormat string

  Format or protocol for receiving webhooks. Possible values:

  • soap
  • http
  • json

  description string

  Your description for this webhook configuration.

  filterMerchantAccountType string

  Shows how merchant accounts are included in company-level webhooks. Possible values:

  • includeAccounts
  • excludeAccounts
  • allAccounts: Includes all merchant accounts, and does not require specifying filterMerchantAccounts.

  filterMerchantAccounts array [string]

  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.

  hasError boolean

  Indicates if the webhook configuration has errors that need troubleshooting. If the value is true, troubleshoot the configuration using the testing endpoint.

  hasPassword boolean

  Indicates if the webhook is password protected.

  hmacKeyCheckValue string

  The checksum of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook.

  id string

  Unique identifier for this webhook.

  networkType string

  Network type for Terminal API details webhooks.

  populateSoapActionHeader boolean

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

  Only applies if communicationFormat: soap.

  sslVersion string

  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.

  type string

  The type of webhook. 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
  • terminal-api-notification

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

  url string

  Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.

  username string

  Username to access the webhook URL.

• 400 - Bad Request

  A problem reading or understanding the request.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 401 - Unauthorized

  Authentication required.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 403 - Forbidden

  Insufficient permissions to process the request.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 422 - Unprocessable Entity

  A request validation error.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 500 - Internal Server Error

  The server could not process the request.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.