Package com.adyen.model.payment

Class ThreeDS2Result

  • public class ThreeDS2Result
extends Object
    ThreeDS2Result

    • Constructor Detail

      • ThreeDS2Result

        public ThreeDS2Result()

    • Method Detail

      • authenticationValue

        public ThreeDS2Result authenticationValue​(String authenticationValue)
        The `authenticationValue` value as defined in the 3D Secure 2 specification.
        Parameters:
        authenticationValue - The `authenticationValue` value as defined in the 3D Secure 2 specification.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getAuthenticationValue

        public String getAuthenticationValue()
        The `authenticationValue` value as defined in the 3D Secure 2 specification.
        Returns:
        authenticationValue The `authenticationValue` value as defined in the 3D Secure 2 specification.

      • setAuthenticationValue

        public void setAuthenticationValue​(String authenticationValue)
        The `authenticationValue` value as defined in the 3D Secure 2 specification.
        Parameters:
        authenticationValue - The `authenticationValue` value as defined in the 3D Secure 2 specification.

      • cavvAlgorithm

        public ThreeDS2Result cavvAlgorithm​(String cavvAlgorithm)
        The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.
        Parameters:
        cavvAlgorithm - The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getCavvAlgorithm

        public String getCavvAlgorithm()
        The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.
        Returns:
        cavvAlgorithm The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.

      • setCavvAlgorithm

        public void setCavvAlgorithm​(String cavvAlgorithm)
        The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.
        Parameters:
        cavvAlgorithm - The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.

      • challengeCancel

        public ThreeDS2Result challengeCancel​(ThreeDS2Result.ChallengeCancelEnum challengeCancel)
        Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
        Parameters:
        challengeCancel - Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getChallengeCancel

        public ThreeDS2Result.ChallengeCancelEnum getChallengeCancel()
        Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
        Returns:
        challengeCancel Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).

      • setChallengeCancel

        public void setChallengeCancel​(ThreeDS2Result.ChallengeCancelEnum challengeCancel)
        Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
        Parameters:
        challengeCancel - Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).

      • dsTransID

        public ThreeDS2Result dsTransID​(String dsTransID)
        The `dsTransID` value as defined in the 3D Secure 2 specification.
        Parameters:
        dsTransID - The `dsTransID` value as defined in the 3D Secure 2 specification.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getDsTransID

        public String getDsTransID()
        The `dsTransID` value as defined in the 3D Secure 2 specification.
        Returns:
        dsTransID The `dsTransID` value as defined in the 3D Secure 2 specification.

      • setDsTransID

        public void setDsTransID​(String dsTransID)
        The `dsTransID` value as defined in the 3D Secure 2 specification.
        Parameters:
        dsTransID - The `dsTransID` value as defined in the 3D Secure 2 specification.

      • eci

        public ThreeDS2Result eci​(String eci)
        The `eci` value as defined in the 3D Secure 2 specification.
        Parameters:
        eci - The `eci` value as defined in the 3D Secure 2 specification.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getEci

        public String getEci()
        The `eci` value as defined in the 3D Secure 2 specification.
        Returns:
        eci The `eci` value as defined in the 3D Secure 2 specification.

      • setEci

        public void setEci​(String eci)
        The `eci` value as defined in the 3D Secure 2 specification.
        Parameters:
        eci - The `eci` value as defined in the 3D Secure 2 specification.

      • exemptionIndicator

        public ThreeDS2Result exemptionIndicator​(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)
        Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis`
        Parameters:
        exemptionIndicator - Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis`
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getExemptionIndicator

        public ThreeDS2Result.ExemptionIndicatorEnum getExemptionIndicator()
        Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis`
        Returns:
        exemptionIndicator Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis`

      • setExemptionIndicator

        public void setExemptionIndicator​(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)
        Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis`
        Parameters:
        exemptionIndicator - Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis`

      • messageVersion

        public ThreeDS2Result messageVersion​(String messageVersion)
        The `messageVersion` value as defined in the 3D Secure 2 specification.
        Parameters:
        messageVersion - The `messageVersion` value as defined in the 3D Secure 2 specification.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getMessageVersion

        public String getMessageVersion()
        The `messageVersion` value as defined in the 3D Secure 2 specification.
        Returns:
        messageVersion The `messageVersion` value as defined in the 3D Secure 2 specification.

      • setMessageVersion

        public void setMessageVersion​(String messageVersion)
        The `messageVersion` value as defined in the 3D Secure 2 specification.
        Parameters:
        messageVersion - The `messageVersion` value as defined in the 3D Secure 2 specification.

      • riskScore

        public ThreeDS2Result riskScore​(String riskScore)
        Risk score calculated by Cartes Bancaires Directory Server (DS).
        Parameters:
        riskScore - Risk score calculated by Cartes Bancaires Directory Server (DS).
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getRiskScore

        public String getRiskScore()
        Risk score calculated by Cartes Bancaires Directory Server (DS).
        Returns:
        riskScore Risk score calculated by Cartes Bancaires Directory Server (DS).

      • setRiskScore

        public void setRiskScore​(String riskScore)
        Risk score calculated by Cartes Bancaires Directory Server (DS).
        Parameters:
        riskScore - Risk score calculated by Cartes Bancaires Directory Server (DS).

      • threeDSRequestorChallengeInd

        public ThreeDS2Result threeDSRequestorChallengeInd​(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)
        Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
        Parameters:
        threeDSRequestorChallengeInd - Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getThreeDSRequestorChallengeInd

        public ThreeDS2Result.ThreeDSRequestorChallengeIndEnum getThreeDSRequestorChallengeInd()
        Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
        Returns:
        threeDSRequestorChallengeInd Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only

      • setThreeDSRequestorChallengeInd

        public void setThreeDSRequestorChallengeInd​(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)
        Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
        Parameters:
        threeDSRequestorChallengeInd - Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only

      • threeDSServerTransID

        public ThreeDS2Result threeDSServerTransID​(String threeDSServerTransID)
        The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.
        Parameters:
        threeDSServerTransID - The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getThreeDSServerTransID

        public String getThreeDSServerTransID()
        The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.
        Returns:
        threeDSServerTransID The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.

      • setThreeDSServerTransID

        public void setThreeDSServerTransID​(String threeDSServerTransID)
        The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.
        Parameters:
        threeDSServerTransID - The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.

      • timestamp

        public ThreeDS2Result timestamp​(String timestamp)
        The `timestamp` value of the 3D Secure 2 authentication.
        Parameters:
        timestamp - The `timestamp` value of the 3D Secure 2 authentication.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getTimestamp

        public String getTimestamp()
        The `timestamp` value of the 3D Secure 2 authentication.
        Returns:
        timestamp The `timestamp` value of the 3D Secure 2 authentication.

      • setTimestamp

        public void setTimestamp​(String timestamp)
        The `timestamp` value of the 3D Secure 2 authentication.
        Parameters:
        timestamp - The `timestamp` value of the 3D Secure 2 authentication.

      • transStatus

        public ThreeDS2Result transStatus​(String transStatus)
        The `transStatus` value as defined in the 3D Secure 2 specification.
        Parameters:
        transStatus - The `transStatus` value as defined in the 3D Secure 2 specification.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getTransStatus

        public String getTransStatus()
        The `transStatus` value as defined in the 3D Secure 2 specification.
        Returns:
        transStatus The `transStatus` value as defined in the 3D Secure 2 specification.

      • setTransStatus

        public void setTransStatus​(String transStatus)
        The `transStatus` value as defined in the 3D Secure 2 specification.
        Parameters:
        transStatus - The `transStatus` value as defined in the 3D Secure 2 specification.

      • transStatusReason

        public ThreeDS2Result transStatusReason​(String transStatusReason)
        Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
        Parameters:
        transStatusReason - Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getTransStatusReason

        public String getTransStatusReason()
        Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
        Returns:
        transStatusReason Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).

      • setTransStatusReason

        public void setTransStatusReason​(String transStatusReason)
        Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
        Parameters:
        transStatusReason - Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).

      • whiteListStatus

        public ThreeDS2Result whiteListStatus​(String whiteListStatus)
        The `whiteListStatus` value as defined in the 3D Secure 2 specification.
        Parameters:
        whiteListStatus - The `whiteListStatus` value as defined in the 3D Secure 2 specification.
        Returns:
        the current ThreeDS2Result instance, allowing for method chaining

      • getWhiteListStatus

        public String getWhiteListStatus()
        The `whiteListStatus` value as defined in the 3D Secure 2 specification.
        Returns:
        whiteListStatus The `whiteListStatus` value as defined in the 3D Secure 2 specification.

      • setWhiteListStatus

        public void setWhiteListStatus​(String whiteListStatus)
        The `whiteListStatus` value as defined in the 3D Secure 2 specification.
        Parameters:
        whiteListStatus - The `whiteListStatus` value as defined in the 3D Secure 2 specification.

      • includeNullValues

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

      • toJson

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