Package com.adyen.model.management

Class CreateCompanyWebhookRequest

  • public class CreateCompanyWebhookRequest
extends Object
    CreateCompanyWebhookRequest

    • Constructor Detail

      • CreateCompanyWebhookRequest

        public CreateCompanyWebhookRequest()

    • Method Detail

      • acceptsExpiredCertificate

        public CreateCompanyWebhookRequest acceptsExpiredCertificate​(Boolean acceptsExpiredCertificate)
        Indicates if expired SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsExpiredCertificate - Indicates if expired SSL certificates are accepted. Default value: **false**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getAcceptsExpiredCertificate

        public Boolean getAcceptsExpiredCertificate()
        Indicates if expired SSL certificates are accepted. Default value: **false**.
        Returns:
        acceptsExpiredCertificate Indicates if expired SSL certificates are accepted. Default value: **false**.

      • setAcceptsExpiredCertificate

        public void setAcceptsExpiredCertificate​(Boolean acceptsExpiredCertificate)
        Indicates if expired SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsExpiredCertificate - Indicates if expired SSL certificates are accepted. Default value: **false**.

      • acceptsSelfSignedCertificate

        public CreateCompanyWebhookRequest acceptsSelfSignedCertificate​(Boolean acceptsSelfSignedCertificate)
        Indicates if self-signed SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsSelfSignedCertificate - Indicates if self-signed SSL certificates are accepted. Default value: **false**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getAcceptsSelfSignedCertificate

        public Boolean getAcceptsSelfSignedCertificate()
        Indicates if self-signed SSL certificates are accepted. Default value: **false**.
        Returns:
        acceptsSelfSignedCertificate Indicates if self-signed SSL certificates are accepted. Default value: **false**.

      • setAcceptsSelfSignedCertificate

        public void setAcceptsSelfSignedCertificate​(Boolean acceptsSelfSignedCertificate)
        Indicates if self-signed SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsSelfSignedCertificate - Indicates if self-signed SSL certificates are accepted. Default value: **false**.

      • acceptsUntrustedRootCertificate

        public CreateCompanyWebhookRequest acceptsUntrustedRootCertificate​(Boolean acceptsUntrustedRootCertificate)
        Indicates if untrusted SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsUntrustedRootCertificate - Indicates if untrusted SSL certificates are accepted. Default value: **false**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getAcceptsUntrustedRootCertificate

        public Boolean getAcceptsUntrustedRootCertificate()
        Indicates if untrusted SSL certificates are accepted. Default value: **false**.
        Returns:
        acceptsUntrustedRootCertificate Indicates if untrusted SSL certificates are accepted. Default value: **false**.

      • setAcceptsUntrustedRootCertificate

        public void setAcceptsUntrustedRootCertificate​(Boolean acceptsUntrustedRootCertificate)
        Indicates if untrusted SSL certificates are accepted. Default value: **false**.
        Parameters:
        acceptsUntrustedRootCertificate - Indicates if untrusted SSL certificates are accepted. Default value: **false**.

      • active

        public CreateCompanyWebhookRequest active​(Boolean active)
        Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.
        Parameters:
        active - Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getActive

        public Boolean getActive()
        Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.
        Returns:
        active Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.

      • setActive

        public void setActive​(Boolean active)
        Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.
        Parameters:
        active - Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.

      • additionalSettings

        public CreateCompanyWebhookRequest additionalSettings​(AdditionalSettings additionalSettings)
        additionalSettings
        Parameters:
        additionalSettings -
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getAdditionalSettings

        public AdditionalSettings getAdditionalSettings()
        Get additionalSettings
        Returns:
        additionalSettings

      • setAdditionalSettings

        public void setAdditionalSettings​(AdditionalSettings additionalSettings)
        additionalSettings
        Parameters:
        additionalSettings -

      • communicationFormat

        public CreateCompanyWebhookRequest communicationFormat​(CreateCompanyWebhookRequest.CommunicationFormatEnum communicationFormat)
        Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**
        Parameters:
        communicationFormat - Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getCommunicationFormat

        public CreateCompanyWebhookRequest.CommunicationFormatEnum getCommunicationFormat()
        Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**
        Returns:
        communicationFormat Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**

      • setCommunicationFormat

        public void setCommunicationFormat​(CreateCompanyWebhookRequest.CommunicationFormatEnum communicationFormat)
        Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**
        Parameters:
        communicationFormat - Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**

      • description

        public CreateCompanyWebhookRequest description​(String description)
        Your description for this webhook configuration.
        Parameters:
        description - Your description for this webhook configuration.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getDescription

        public String getDescription()
        Your description for this webhook configuration.
        Returns:
        description Your description for this webhook configuration.

      • setDescription

        public void setDescription​(String description)
        Your description for this webhook configuration.
        Parameters:
        description - Your description for this webhook configuration.

      • encryptionProtocol

        public CreateCompanyWebhookRequest encryptionProtocol​(CreateCompanyWebhookRequest.EncryptionProtocolEnum 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**.
        Parameters:
        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**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getEncryptionProtocol

        public CreateCompanyWebhookRequest.EncryptionProtocolEnum getEncryptionProtocol()
        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**.
        Returns:
        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**.

      • setEncryptionProtocol

        public void setEncryptionProtocol​(CreateCompanyWebhookRequest.EncryptionProtocolEnum 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**.
        Parameters:
        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

        public CreateCompanyWebhookRequest filterMerchantAccountType​(CreateCompanyWebhookRequest.FilterMerchantAccountTypeEnum 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`.
        Parameters:
        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`.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getFilterMerchantAccountType

        public CreateCompanyWebhookRequest.FilterMerchantAccountTypeEnum getFilterMerchantAccountType()
        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`.
        Returns:
        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`.

      • setFilterMerchantAccountType

        public void setFilterMerchantAccountType​(CreateCompanyWebhookRequest.FilterMerchantAccountTypeEnum 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`.
        Parameters:
        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

        public CreateCompanyWebhookRequest filterMerchantAccounts​(List<String> 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**.
        Parameters:
        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**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getFilterMerchantAccounts

        public List<String> getFilterMerchantAccounts()
        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**.
        Returns:
        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**.

      • setFilterMerchantAccounts

        public void setFilterMerchantAccounts​(List<String> 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**.
        Parameters:
        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

        public CreateCompanyWebhookRequest networkType​(CreateCompanyWebhookRequest.NetworkTypeEnum networkType)
        Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.
        Parameters:
        networkType - Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getNetworkType

        public CreateCompanyWebhookRequest.NetworkTypeEnum getNetworkType()
        Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.
        Returns:
        networkType Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.

      • setNetworkType

        public void setNetworkType​(CreateCompanyWebhookRequest.NetworkTypeEnum networkType)
        Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.
        Parameters:
        networkType - Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.

      • password

        public CreateCompanyWebhookRequest password​(String password)
        Password to access the webhook URL.
        Parameters:
        password - Password to access the webhook URL.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getPassword

        public String getPassword()
        Password to access the webhook URL.
        Returns:
        password Password to access the webhook URL.

      • setPassword

        public void setPassword​(String password)
        Password to access the webhook URL.
        Parameters:
        password - Password to access the webhook URL.

      • populateSoapActionHeader

        public CreateCompanyWebhookRequest populateSoapActionHeader​(Boolean populateSoapActionHeader)
        Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.
        Parameters:
        populateSoapActionHeader - Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getPopulateSoapActionHeader

        public Boolean getPopulateSoapActionHeader()
        Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.
        Returns:
        populateSoapActionHeader Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.

      • setPopulateSoapActionHeader

        public void setPopulateSoapActionHeader​(Boolean populateSoapActionHeader)
        Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.
        Parameters:
        populateSoapActionHeader - Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.

      • type

        public CreateCompanyWebhookRequest type​(String 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](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks).
        Parameters:
        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](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks).
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getType

        public String getType()
        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](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks).
        Returns:
        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](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks).

      • setType

        public void setType​(String 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](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks).
        Parameters:
        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](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks).

      • url

        public CreateCompanyWebhookRequest url​(String url)
        Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.
        Parameters:
        url - Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getUrl

        public String getUrl()
        Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.
        Returns:
        url Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.

      • setUrl

        public void setUrl​(String url)
        Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.
        Parameters:
        url - Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.

      • username

        public CreateCompanyWebhookRequest username​(String username)
        Username to access the webhook URL.
        Parameters:
        username - Username to access the webhook URL.
        Returns:
        the current CreateCompanyWebhookRequest instance, allowing for method chaining

      • getUsername

        public String getUsername()
        Username to access the webhook URL.
        Returns:
        username Username to access the webhook URL.

      • setUsername

        public void setUsername​(String username)
        Username to access the webhook URL.
        Parameters:
        username - Username to access the webhook URL.

      • includeNullValues

        public CreateCompanyWebhookRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

        public boolean equals​(Object o)
        Return true if this CreateCompanyWebhookRequest object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • fromJson

        public static CreateCompanyWebhookRequest fromJson​(String jsonString)
                                            throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CreateCompanyWebhookRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CreateCompanyWebhookRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CreateCompanyWebhookRequest

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CreateCompanyWebhookRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException