| active |
kotlin.Boolean |
Indicates if the webhook configuration is active. The field must be true for you to receive webhooks about events related an account. |
|
| communicationFormat |
inline |
Format or protocol for receiving webhooks. Possible values: * soap * http * json |
|
| type |
kotlin.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 |
kotlin.String |
Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint. |
|
| links |
WebhookLinks |
|
[optional] |
| acceptsExpiredCertificate |
kotlin.Boolean |
Indicates if expired SSL certificates are accepted. Default value: false. |
[optional] |
| acceptsSelfSignedCertificate |
kotlin.Boolean |
Indicates if self-signed SSL certificates are accepted. Default value: false. |
[optional] |
| acceptsUntrustedRootCertificate |
kotlin.Boolean |
Indicates if untrusted SSL certificates are accepted. Default value: false. |
[optional] |
| accountReference |
kotlin.String |
Reference to the account the webook is set on. |
[optional] |
| additionalSettings |
AdditionalSettingsResponse |
|
[optional] |
| certificateAlias |
kotlin.String |
The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias. |
[optional] |
| description |
kotlin.String |
Your description for this webhook configuration. |
[optional] |
| encryptionProtocol |
inline |
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. |
[optional] |
| filterMerchantAccountType |
inline |
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`. |
[optional] |
| filterMerchantAccounts |
kotlin.collections.List<kotlin.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. |
[optional] |
| hasError |
kotlin.Boolean |
Indicates if the webhook configuration has errors that need troubleshooting. If the value is true, troubleshoot the configuration using the testing endpoint. |
[optional] |
| hasPassword |
kotlin.Boolean |
Indicates if the webhook is password protected. |
[optional] |
| hmacKeyCheckValue |
kotlin.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. |
[optional] |
| id |
kotlin.String |
Unique identifier for this webhook. |
[optional] |
| networkType |
inline |
Network type for Terminal API details webhooks. |
[optional] |
| populateSoapActionHeader |
kotlin.Boolean |
Indicates if the SOAP action header needs to be populated. Default value: false. Only applies if `communicationFormat`: soap. |
[optional] |
| username |
kotlin.String |
Username to access the webhook URL. |
[optional] |