Package com.adyen.model.checkout

Class AdditionalData3DSecure

  • public class AdditionalData3DSecure
extends Object
    AdditionalData3DSecure

    • Constructor Detail

      • AdditionalData3DSecure

        public AdditionalData3DSecure()

    • Method Detail

      • allow3DS2

        @Deprecated
public AdditionalData3DSecure allow3DS2​(String allow3DS2)
        Deprecated.
        since Adyen Checkout API v69 Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.
        Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.
        Parameters:
        allow3DS2 -
        Returns:
        the current AdditionalData3DSecure instance, allowing for method chaining

      • getAllow3DS2

        @Deprecated
public String getAllow3DS2()
        Deprecated.
        since Adyen Checkout API v69 Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.
        Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.
        Returns:
        allow3DS2

      • setAllow3DS2

        @Deprecated
public void setAllow3DS2​(String allow3DS2)
        Deprecated.
        since Adyen Checkout API v69 Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.
        Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.
        Parameters:
        allow3DS2 -

      • challengeWindowSize

        public AdditionalData3DSecure challengeWindowSize​(AdditionalData3DSecure.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 -
        Returns:
        the current AdditionalData3DSecure instance, allowing for method chaining

      • getChallengeWindowSize

        public AdditionalData3DSecure.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

      • setChallengeWindowSize

        public void setChallengeWindowSize​(AdditionalData3DSecure.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 -

      • executeThreeD

        @Deprecated
public AdditionalData3DSecure executeThreeD​(String executeThreeD)
        Deprecated.
        since Adyen Checkout API v69 Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead
        Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations.
        Parameters:
        executeThreeD -
        Returns:
        the current AdditionalData3DSecure instance, allowing for method chaining

      • getExecuteThreeD

        @Deprecated
public String getExecuteThreeD()
        Deprecated.
        since Adyen Checkout API v69 Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead
        Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations.
        Returns:
        executeThreeD

      • setExecuteThreeD

        @Deprecated
public void setExecuteThreeD​(String executeThreeD)
        Deprecated.
        since Adyen Checkout API v69 Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead
        Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations.
        Parameters:
        executeThreeD -

      • mpiImplementationType

        public AdditionalData3DSecure mpiImplementationType​(String mpiImplementationType)
        In case of Secure+, this field must be set to **CUPSecurePlus**.
        Parameters:
        mpiImplementationType -
        Returns:
        the current AdditionalData3DSecure instance, allowing for method chaining

      • getMpiImplementationType

        public String getMpiImplementationType()
        In case of Secure+, this field must be set to **CUPSecurePlus**.
        Returns:
        mpiImplementationType

      • setMpiImplementationType

        public void setMpiImplementationType​(String mpiImplementationType)
        In case of Secure+, this field must be set to **CUPSecurePlus**.
        Parameters:
        mpiImplementationType -

      • scaExemption

        public AdditionalData3DSecure scaExemption​(String scaExemption)
        Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis**
        Parameters:
        scaExemption -
        Returns:
        the current AdditionalData3DSecure instance, allowing for method chaining

      • getScaExemption

        public String getScaExemption()
        Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis**
        Returns:
        scaExemption

      • setScaExemption

        public void setScaExemption​(String scaExemption)
        Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis**
        Parameters:
        scaExemption -

      • threeDSVersion

        public AdditionalData3DSecure threeDSVersion​(String threeDSVersion)
        Indicates your preference for the 3D Secure version. > If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure. Possible values: * **1.0.2**: Apply 3D Secure version 1.0.2. * **2.1.0**: Apply 3D Secure version 2.1.0. * **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0. The following rules apply: * If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2. * If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.
        Parameters:
        threeDSVersion -
        Returns:
        the current AdditionalData3DSecure instance, allowing for method chaining

      • getThreeDSVersion

        public String getThreeDSVersion()
        Indicates your preference for the 3D Secure version. > If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure. Possible values: * **1.0.2**: Apply 3D Secure version 1.0.2. * **2.1.0**: Apply 3D Secure version 2.1.0. * **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0. The following rules apply: * If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2. * If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.
        Returns:
        threeDSVersion

      • setThreeDSVersion

        public void setThreeDSVersion​(String threeDSVersion)
        Indicates your preference for the 3D Secure version. > If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure. Possible values: * **1.0.2**: Apply 3D Secure version 1.0.2. * **2.1.0**: Apply 3D Secure version 2.1.0. * **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0. The following rules apply: * If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2. * If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.
        Parameters:
        threeDSVersion -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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