CreateCompanyWebhookRequest class abstract

CreateCompanyWebhookRequest

Properties:

  • 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.
  • active - Indicates if the webhook configuration is active. The field must be true for us to send 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.
  • 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 filtered when configuring the webhook. Possible values: * allAccounts : Includes all merchant accounts, and does not require specifying filterMerchantAccounts. * includeAccounts : The webhook is configured for the merchant accounts listed in filterMerchantAccounts. * excludeAccounts : The webhook is not configured for the merchant accounts listed in 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.
  • networkType - Network type for Terminal API notification webhooks. Possible values: * public * local Default Value: public.
  • password - Password to access the webhook URL.
  • populateSoapActionHeader - Indicates if the SOAP action header needs to be populated. Default value: false. Only applies if communicationFormat: soap.
  • type - The type of webhook that is being created. 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 - rreq-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

CreateCompanyWebhookRequest([void updates(CreateCompanyWebhookRequestBuilder 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
active → bool
Indicates if the webhook configuration is active. The field must be true for us to send webhooks about events related an account.
no setter
additionalSettings → AdditionalSettings?
Additional shopper and transaction information to be included in your standard webhooks. Find out more about the available additional settings.
no setter
communicationFormat → CreateCompanyWebhookRequestCommunicationFormatEnum
Format or protocol for receiving webhooks. Possible values: * soap * http * json
no setter
description → String?
Your description for this webhook configuration.
no setter
encryptionProtocol → CreateCompanyWebhookRequestEncryptionProtocolEnum?
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 → CreateCompanyWebhookRequestFilterMerchantAccountTypeEnum
Shows how merchant accounts are filtered when configuring the webhook. Possible values: * allAccounts : Includes all merchant accounts, and does not require specifying filterMerchantAccounts. * includeAccounts : The webhook is configured for the merchant accounts listed in filterMerchantAccounts. * excludeAccounts : The webhook is not configured for the merchant accounts listed in filterMerchantAccounts.
no setter
hashCode → int
The hash code for this object.
no setterinherited
networkType → CreateCompanyWebhookRequestNetworkTypeEnum?
Network type for Terminal API notification webhooks. Possible values: * public * local Default Value: public.
no setter
password → String?
Password to access the webhook URL.
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 that is being created. 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 - rreq-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(CreateCompanyWebhookRequestBuilder)) → CreateCompanyWebhookRequest
Rebuilds the instance.
inherited
toBuilder() → CreateCompanyWebhookRequestBuilder
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<CreateCompanyWebhookRequest>
no setter