Package com.adyen.model.management
Class CreateMerchantWebhookRequest
- java.lang.Object
-
- com.adyen.model.management.CreateMerchantWebhookRequest
-
public class CreateMerchantWebhookRequest extends Object
CreateMerchantWebhookRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCreateMerchantWebhookRequest.CommunicationFormatEnumFormat or protocol for receiving webhooks.static classCreateMerchantWebhookRequest.EncryptionProtocolEnumSSL version to access the public webhook URL specified in the `url` field.static classCreateMerchantWebhookRequest.NetworkTypeEnumNetwork type for Terminal API notification webhooks.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATEstatic StringJSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATEstatic StringJSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATEstatic StringJSON_PROPERTY_ACTIVEstatic StringJSON_PROPERTY_ADDITIONAL_SETTINGSstatic StringJSON_PROPERTY_COMMUNICATION_FORMATstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_ENCRYPTION_PROTOCOLstatic StringJSON_PROPERTY_NETWORK_TYPEstatic StringJSON_PROPERTY_PASSWORDstatic StringJSON_PROPERTY_POPULATE_SOAP_ACTION_HEADERstatic StringJSON_PROPERTY_TYPEstatic StringJSON_PROPERTY_URLstatic StringJSON_PROPERTY_USERNAME
-
Constructor Summary
Constructors Constructor Description CreateMerchantWebhookRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateMerchantWebhookRequestacceptsExpiredCertificate(Boolean acceptsExpiredCertificate)CreateMerchantWebhookRequestacceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate)CreateMerchantWebhookRequestacceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate)CreateMerchantWebhookRequestactive(Boolean active)CreateMerchantWebhookRequestadditionalSettings(AdditionalSettings additionalSettings)CreateMerchantWebhookRequestcommunicationFormat(CreateMerchantWebhookRequest.CommunicationFormatEnum communicationFormat)CreateMerchantWebhookRequestdescription(String description)CreateMerchantWebhookRequestencryptionProtocol(CreateMerchantWebhookRequest.EncryptionProtocolEnum encryptionProtocol)booleanequals(Object o)Return true if this CreateMerchantWebhookRequest object is equal to o.static CreateMerchantWebhookRequestfromJson(String jsonString)Create an instance of CreateMerchantWebhookRequest given an JSON stringBooleangetAcceptsExpiredCertificate()Indicates if expired SSL certificates are accepted.BooleangetAcceptsSelfSignedCertificate()Indicates if self-signed SSL certificates are accepted.BooleangetAcceptsUntrustedRootCertificate()Indicates if untrusted SSL certificates are accepted.BooleangetActive()Indicates if the webhook configuration is active.AdditionalSettingsgetAdditionalSettings()Get additionalSettingsCreateMerchantWebhookRequest.CommunicationFormatEnumgetCommunicationFormat()Format or protocol for receiving webhooks.StringgetDescription()Your description for this webhook configuration.CreateMerchantWebhookRequest.EncryptionProtocolEnumgetEncryptionProtocol()SSL version to access the public webhook URL specified in the `url` field.CreateMerchantWebhookRequest.NetworkTypeEnumgetNetworkType()Network type for Terminal API notification webhooks.StringgetPassword()Password to access the webhook URL.BooleangetPopulateSoapActionHeader()Indicates if the SOAP action header needs to be populated.StringgetType()The type of webhook that is being created.StringgetUrl()Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.StringgetUsername()Username to access the webhook URL.inthashCode()CreateMerchantWebhookRequestnetworkType(CreateMerchantWebhookRequest.NetworkTypeEnum networkType)CreateMerchantWebhookRequestpassword(String password)CreateMerchantWebhookRequestpopulateSoapActionHeader(Boolean populateSoapActionHeader)voidsetAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate)Indicates if expired SSL certificates are accepted.voidsetAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate)Indicates if self-signed SSL certificates are accepted.voidsetAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate)Indicates if untrusted SSL certificates are accepted.voidsetActive(Boolean active)Indicates if the webhook configuration is active.voidsetAdditionalSettings(AdditionalSettings additionalSettings)additionalSettingsvoidsetCommunicationFormat(CreateMerchantWebhookRequest.CommunicationFormatEnum communicationFormat)Format or protocol for receiving webhooks.voidsetDescription(String description)Your description for this webhook configuration.voidsetEncryptionProtocol(CreateMerchantWebhookRequest.EncryptionProtocolEnum encryptionProtocol)SSL version to access the public webhook URL specified in the `url` field.voidsetNetworkType(CreateMerchantWebhookRequest.NetworkTypeEnum networkType)Network type for Terminal API notification webhooks.voidsetPassword(String password)Password to access the webhook URL.voidsetPopulateSoapActionHeader(Boolean populateSoapActionHeader)Indicates if the SOAP action header needs to be populated.voidsetType(String type)The type of webhook that is being created.voidsetUrl(String url)Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.voidsetUsername(String username)Username to access the webhook URL.StringtoJson()Convert an instance of CreateMerchantWebhookRequest to an JSON stringStringtoString()CreateMerchantWebhookRequesttype(String type)CreateMerchantWebhookRequesturl(String url)CreateMerchantWebhookRequestusername(String username)
-
-
-
Field Detail
-
JSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATE
public static final String JSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATE
public static final String JSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE
public static final String JSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ACTIVE
public static final String JSON_PROPERTY_ACTIVE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDITIONAL_SETTINGS
public static final String JSON_PROPERTY_ADDITIONAL_SETTINGS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COMMUNICATION_FORMAT
public static final String JSON_PROPERTY_COMMUNICATION_FORMAT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENCRYPTION_PROTOCOL
public static final String JSON_PROPERTY_ENCRYPTION_PROTOCOL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NETWORK_TYPE
public static final String JSON_PROPERTY_NETWORK_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PASSWORD
public static final String JSON_PROPERTY_PASSWORD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_POPULATE_SOAP_ACTION_HEADER
public static final String JSON_PROPERTY_POPULATE_SOAP_ACTION_HEADER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_URL
public static final String JSON_PROPERTY_URL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USERNAME
public static final String JSON_PROPERTY_USERNAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptsExpiredCertificate
public CreateMerchantWebhookRequest acceptsExpiredCertificate(Boolean acceptsExpiredCertificate)
-
getAcceptsExpiredCertificate
public Boolean getAcceptsExpiredCertificate()
Indicates if expired SSL certificates are accepted. Default value: **false**.- Returns:
- acceptsExpiredCertificate
-
setAcceptsExpiredCertificate
public void setAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate)
Indicates if expired SSL certificates are accepted. Default value: **false**.- Parameters:
acceptsExpiredCertificate-
-
acceptsSelfSignedCertificate
public CreateMerchantWebhookRequest acceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate)
-
getAcceptsSelfSignedCertificate
public Boolean getAcceptsSelfSignedCertificate()
Indicates if self-signed SSL certificates are accepted. Default value: **false**.- Returns:
- acceptsSelfSignedCertificate
-
setAcceptsSelfSignedCertificate
public void setAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate)
Indicates if self-signed SSL certificates are accepted. Default value: **false**.- Parameters:
acceptsSelfSignedCertificate-
-
acceptsUntrustedRootCertificate
public CreateMerchantWebhookRequest acceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate)
-
getAcceptsUntrustedRootCertificate
public Boolean getAcceptsUntrustedRootCertificate()
Indicates if untrusted SSL certificates are accepted. Default value: **false**.- Returns:
- acceptsUntrustedRootCertificate
-
setAcceptsUntrustedRootCertificate
public void setAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate)
Indicates if untrusted SSL certificates are accepted. Default value: **false**.- Parameters:
acceptsUntrustedRootCertificate-
-
active
public CreateMerchantWebhookRequest active(Boolean active)
-
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
-
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-
-
additionalSettings
public CreateMerchantWebhookRequest additionalSettings(AdditionalSettings additionalSettings)
-
getAdditionalSettings
public AdditionalSettings getAdditionalSettings()
Get additionalSettings- Returns:
- additionalSettings
-
setAdditionalSettings
public void setAdditionalSettings(AdditionalSettings additionalSettings)
additionalSettings- Parameters:
additionalSettings-
-
communicationFormat
public CreateMerchantWebhookRequest communicationFormat(CreateMerchantWebhookRequest.CommunicationFormatEnum communicationFormat)
-
getCommunicationFormat
public CreateMerchantWebhookRequest.CommunicationFormatEnum getCommunicationFormat()
Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**- Returns:
- communicationFormat
-
setCommunicationFormat
public void setCommunicationFormat(CreateMerchantWebhookRequest.CommunicationFormatEnum communicationFormat)
Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**- Parameters:
communicationFormat-
-
description
public CreateMerchantWebhookRequest description(String description)
-
getDescription
public String getDescription()
Your description for this webhook configuration.- Returns:
- description
-
setDescription
public void setDescription(String description)
Your description for this webhook configuration.- Parameters:
description-
-
encryptionProtocol
public CreateMerchantWebhookRequest encryptionProtocol(CreateMerchantWebhookRequest.EncryptionProtocolEnum encryptionProtocol)
-
getEncryptionProtocol
public CreateMerchantWebhookRequest.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
-
setEncryptionProtocol
public void setEncryptionProtocol(CreateMerchantWebhookRequest.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-
-
networkType
public CreateMerchantWebhookRequest networkType(CreateMerchantWebhookRequest.NetworkTypeEnum networkType)
-
getNetworkType
public CreateMerchantWebhookRequest.NetworkTypeEnum getNetworkType()
Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.- Returns:
- networkType
-
setNetworkType
public void setNetworkType(CreateMerchantWebhookRequest.NetworkTypeEnum networkType)
Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**.- Parameters:
networkType-
-
password
public CreateMerchantWebhookRequest password(String password)
-
getPassword
public String getPassword()
Password to access the webhook URL.- Returns:
- password
-
setPassword
public void setPassword(String password)
Password to access the webhook URL.- Parameters:
password-
-
populateSoapActionHeader
public CreateMerchantWebhookRequest populateSoapActionHeader(Boolean populateSoapActionHeader)
-
getPopulateSoapActionHeader
public Boolean getPopulateSoapActionHeader()
Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**.- Returns:
- populateSoapActionHeader
-
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-
-
type
public CreateMerchantWebhookRequest type(String type)
-
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** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).- Returns:
- type
-
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** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).- Parameters:
type-
-
url
public CreateMerchantWebhookRequest url(String url)
-
getUrl
public String getUrl()
Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.- Returns:
- url
-
setUrl
public void setUrl(String url)
Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.- Parameters:
url-
-
username
public CreateMerchantWebhookRequest username(String username)
-
getUsername
public String getUsername()
Username to access the webhook URL.- Returns:
- username
-
setUsername
public void setUsername(String username)
Username to access the webhook URL.- Parameters:
username-
-
equals
public boolean equals(Object o)
Return true if this CreateMerchantWebhookRequest object is equal to o.
-
fromJson
public static CreateMerchantWebhookRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of CreateMerchantWebhookRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateMerchantWebhookRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to CreateMerchantWebhookRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of CreateMerchantWebhookRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-