Package com.adyen.model.payment

Class ThreeDSecureData

  • public class ThreeDSecureData
extends Object
    ThreeDSecureData

    • Constructor Detail

      • ThreeDSecureData

        public ThreeDSecureData()

    • Method Detail

      • authenticationResponse

        public ThreeDSecureData authenticationResponse​(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)
        In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
        Parameters:
        authenticationResponse - In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getAuthenticationResponse

        public ThreeDSecureData.AuthenticationResponseEnum getAuthenticationResponse()
        In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
        Returns:
        authenticationResponse In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.

      • setAuthenticationResponse

        public void setAuthenticationResponse​(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)
        In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
        Parameters:
        authenticationResponse - In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.

      • cavv

        public ThreeDSecureData cavv​(byte[] cavv)
        The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
        Parameters:
        cavv - The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getCavv

        public byte[] getCavv()
        The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
        Returns:
        cavv The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).

      • setCavv

        public void setCavv​(byte[] cavv)
        The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
        Parameters:
        cavv - The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).

      • cavvAlgorithm

        public ThreeDSecureData cavvAlgorithm​(String cavvAlgorithm)
        The CAVV algorithm used. Include this only for 3D Secure 1.
        Parameters:
        cavvAlgorithm - The CAVV algorithm used. Include this only for 3D Secure 1.
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getCavvAlgorithm

        public String getCavvAlgorithm()
        The CAVV algorithm used. Include this only for 3D Secure 1.
        Returns:
        cavvAlgorithm The CAVV algorithm used. Include this only for 3D Secure 1.

      • setCavvAlgorithm

        public void setCavvAlgorithm​(String cavvAlgorithm)
        The CAVV algorithm used. Include this only for 3D Secure 1.
        Parameters:
        cavvAlgorithm - The CAVV algorithm used. Include this only for 3D Secure 1.

      • challengeCancel

        public ThreeDSecureData challengeCancel​(ThreeDSecureData.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 ThreeDSecureData instance, allowing for method chaining

      • getChallengeCancel

        public ThreeDSecureData.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​(ThreeDSecureData.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).

      • directoryResponse

        public ThreeDSecureData directoryResponse​(ThreeDSecureData.DirectoryResponseEnum directoryResponse)
        In 3D Secure 2, this is the `transStatus` from the `ARes`.
        Parameters:
        directoryResponse - In 3D Secure 2, this is the `transStatus` from the `ARes`.
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getDirectoryResponse

        public ThreeDSecureData.DirectoryResponseEnum getDirectoryResponse()
        In 3D Secure 2, this is the `transStatus` from the `ARes`.
        Returns:
        directoryResponse In 3D Secure 2, this is the `transStatus` from the `ARes`.

      • setDirectoryResponse

        public void setDirectoryResponse​(ThreeDSecureData.DirectoryResponseEnum directoryResponse)
        In 3D Secure 2, this is the `transStatus` from the `ARes`.
        Parameters:
        directoryResponse - In 3D Secure 2, this is the `transStatus` from the `ARes`.

      • dsTransID

        public ThreeDSecureData dsTransID​(String dsTransID)
        Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
        Parameters:
        dsTransID - Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getDsTransID

        public String getDsTransID()
        Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
        Returns:
        dsTransID Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

      • setDsTransID

        public void setDsTransID​(String dsTransID)
        Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
        Parameters:
        dsTransID - Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

      • eci

        public ThreeDSecureData eci​(String eci)
        The electronic commerce indicator.
        Parameters:
        eci - The electronic commerce indicator.
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getEci

        public String getEci()
        The electronic commerce indicator.
        Returns:
        eci The electronic commerce indicator.

      • setEci

        public void setEci​(String eci)
        The electronic commerce indicator.
        Parameters:
        eci - The electronic commerce indicator.

      • riskScore

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

      • getRiskScore

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

      • setRiskScore

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

      • threeDSVersion

        public ThreeDSecureData threeDSVersion​(String threeDSVersion)
        The version of the 3D Secure protocol.
        Parameters:
        threeDSVersion - The version of the 3D Secure protocol.
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getThreeDSVersion

        public String getThreeDSVersion()
        The version of the 3D Secure protocol.
        Returns:
        threeDSVersion The version of the 3D Secure protocol.

      • setThreeDSVersion

        public void setThreeDSVersion​(String threeDSVersion)
        The version of the 3D Secure protocol.
        Parameters:
        threeDSVersion - The version of the 3D Secure protocol.

      • tokenAuthenticationVerificationValue

        public ThreeDSecureData tokenAuthenticationVerificationValue​(byte[] tokenAuthenticationVerificationValue)
        Network token authentication verification value (TAVV). The network token cryptogram.
        Parameters:
        tokenAuthenticationVerificationValue - Network token authentication verification value (TAVV). The network token cryptogram.
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getTokenAuthenticationVerificationValue

        public byte[] getTokenAuthenticationVerificationValue()
        Network token authentication verification value (TAVV). The network token cryptogram.
        Returns:
        tokenAuthenticationVerificationValue Network token authentication verification value (TAVV). The network token cryptogram.

      • setTokenAuthenticationVerificationValue

        public void setTokenAuthenticationVerificationValue​(byte[] tokenAuthenticationVerificationValue)
        Network token authentication verification value (TAVV). The network token cryptogram.
        Parameters:
        tokenAuthenticationVerificationValue - Network token authentication verification value (TAVV). The network token cryptogram.

      • transStatusReason

        public ThreeDSecureData 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 ThreeDSecureData 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).

      • xid

        public ThreeDSecureData xid​(byte[] xid)
        Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
        Parameters:
        xid - Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
        Returns:
        the current ThreeDSecureData instance, allowing for method chaining

      • getXid

        public byte[] getXid()
        Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
        Returns:
        xid Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).

      • setXid

        public void setXid​(byte[] xid)
        Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
        Parameters:
        xid - Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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