Package com.adyen.model.checkout

Class ThreeDSRequestData

  • public class ThreeDSRequestData
extends Object
    ThreeDSRequestData

    • Constructor Detail

      • ThreeDSRequestData

        public ThreeDSRequestData()

    • Method Detail

      • challengeWindowSize

        public ThreeDSRequestData challengeWindowSize​(ThreeDSRequestData.ChallengeWindowSizeEnum challengeWindowSize)
        Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen
        Parameters:
        challengeWindowSize - Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen
        Returns:
        the current ThreeDSRequestData instance, allowing for method chaining

      • getChallengeWindowSize

        public ThreeDSRequestData.ChallengeWindowSizeEnum getChallengeWindowSize()
        Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen
        Returns:
        challengeWindowSize Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen

      • setChallengeWindowSize

        public void setChallengeWindowSize​(ThreeDSRequestData.ChallengeWindowSizeEnum challengeWindowSize)
        Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen
        Parameters:
        challengeWindowSize - Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen

      • dataOnly

        public ThreeDSRequestData dataOnly​(ThreeDSRequestData.DataOnlyEnum dataOnly)
        Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.
        Parameters:
        dataOnly - Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.
        Returns:
        the current ThreeDSRequestData instance, allowing for method chaining

      • getDataOnly

        public ThreeDSRequestData.DataOnlyEnum getDataOnly()
        Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.
        Returns:
        dataOnly Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.

      • setDataOnly

        public void setDataOnly​(ThreeDSRequestData.DataOnlyEnum dataOnly)
        Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.
        Parameters:
        dataOnly - Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.

      • nativeThreeDS

        public ThreeDSRequestData nativeThreeDS​(ThreeDSRequestData.NativeThreeDSEnum nativeThreeDS)
        Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.
        Parameters:
        nativeThreeDS - Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.
        Returns:
        the current ThreeDSRequestData instance, allowing for method chaining

      • getNativeThreeDS

        public ThreeDSRequestData.NativeThreeDSEnum getNativeThreeDS()
        Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.
        Returns:
        nativeThreeDS Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.

      • setNativeThreeDS

        public void setNativeThreeDS​(ThreeDSRequestData.NativeThreeDSEnum nativeThreeDS)
        Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.
        Parameters:
        nativeThreeDS - Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.

      • threeDSVersion

        public ThreeDSRequestData threeDSVersion​(ThreeDSRequestData.ThreeDSVersionEnum threeDSVersion)
        The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**
        Parameters:
        threeDSVersion - The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**
        Returns:
        the current ThreeDSRequestData instance, allowing for method chaining

      • getThreeDSVersion

        public ThreeDSRequestData.ThreeDSVersionEnum getThreeDSVersion()
        The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**
        Returns:
        threeDSVersion The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**

      • setThreeDSVersion

        public void setThreeDSVersion​(ThreeDSRequestData.ThreeDSVersionEnum threeDSVersion)
        The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**
        Parameters:
        threeDSVersion - The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**

      • includeNullValues

        public ThreeDSRequestData 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 ThreeDSRequestData 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 ThreeDSRequestData fromJson​(String jsonString)
                                   throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of ThreeDSRequestData given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ThreeDSRequestData
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ThreeDSRequestData

      • toJson

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