Webhook class abstract

Webhook

Properties:

  • links - References to resources connected with this webhook.
  • acceptsExpiredCertificate - Indicates if expired SSL certificates are accepted. Default value: false.
  • acceptsSelfSignedCertificate - Indicates if self-signed SSL certificates are accepted. Default value: false.
  • acceptsUntrustedRootCertificate - Indicates if untrusted SSL certificates are accepted. Default value: false.
  • accountReference - Reference to the account the webook is set on.
  • active - Indicates if the webhook configuration is active. The field must be true for you to receive webhooks about events related an account.
  • additionalSettings - Additional shopper and transaction information to be included in your standard webhooks. Find out more about the available additional settings.
  • certificateAlias - The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.
  • communicationFormat - Format or protocol for receiving webhooks. Possible values: * soap * http * json
  • description - Your description for this webhook configuration.
  • encryptionProtocol - 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.
  • filterMerchantAccountType - 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 - 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 - Indicates if the webhook configuration has errors that need troubleshooting. If the value is true, troubleshoot the configuration using the testing endpoint.
  • hasPassword - Indicates if the webhook is password protected.
  • hmacKeyCheckValue - 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 - Unique identifier for this webhook.
  • networkType - Network type for Terminal API details webhooks.
  • populateSoapActionHeader - Indicates if the SOAP action header needs to be populated. Default value: false. Only applies if communicationFormat: soap.
  • type - The type of webhook. Possible values are: - standard - account-settings-notification - banktransfer-notification - boletobancario-notification - directdebit-notification - ach-notification-of-change-notification - direct-debit-notice-of-change-notification - pending-notification - ideal-notification - ideal-pending-notification - report-notification - terminal-api-notification - terminal-settings - terminal-boarding Find out more about standard webhooks and other types of webhooks.
  • url - Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.
  • username - Username to access the webhook URL.
Annotations
  • @BuiltValue.new()

Constructors

Webhook([void updates(WebhookBuilder b)])
factory

Properties

acceptsExpiredCertificate → bool?
Indicates if expired SSL certificates are accepted. Default value: false.
no setter
acceptsSelfSignedCertificate → bool?
Indicates if self-signed SSL certificates are accepted. Default value: false.
no setter
acceptsUntrustedRootCertificate → bool?
Indicates if untrusted SSL certificates are accepted. Default value: false.
no setter
accountReference → String?
Reference to the account the webook is set on.
no setter
active → bool
Indicates if the webhook configuration is active. The field must be true for you to receive webhooks about events related an account.
no setter
additionalSettings → AdditionalSettingsResponse?
Additional shopper and transaction information to be included in your standard webhooks. Find out more about the available additional settings.
no setter
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.
no setter
communicationFormat → WebhookCommunicationFormatEnum
Format or protocol for receiving webhooks. Possible values: * soap * http * json
no setter
description → String?
Your description for this webhook configuration.
no setter
encryptionProtocol → WebhookEncryptionProtocolEnum?
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.
no setter
filterMerchantAccounts → BuiltList<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.
no setter
filterMerchantAccountType → WebhookFilterMerchantAccountTypeEnum?
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.
no setter
hasError → bool?
Indicates if the webhook configuration has errors that need troubleshooting. If the value is true, troubleshoot the configuration using the testing endpoint.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasPassword → bool?
Indicates if the webhook is password protected.
no setter
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.
no setter
id → String?
Unique identifier for this webhook.
no setter
References to resources connected with this webhook.
no setter
networkType → WebhookNetworkTypeEnum?
Network type for Terminal API details webhooks.
no setter
populateSoapActionHeader → bool?
Indicates if the SOAP action header needs to be populated. Default value: false. Only applies if communicationFormat: soap.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → String
The type of webhook. Possible values are: - standard - account-settings-notification - banktransfer-notification - boletobancario-notification - directdebit-notification - ach-notification-of-change-notification - direct-debit-notice-of-change-notification - pending-notification - ideal-notification - ideal-pending-notification - report-notification - terminal-api-notification - terminal-settings - terminal-boarding Find out more about standard webhooks and other types of webhooks.
no setter
url → String
Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.
no setter
username → String?
Username to access the webhook URL.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(WebhookBuilder)) → Webhook
Rebuilds the instance.
inherited
toBuilder() → WebhookBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<Webhook>
no setter