java.lang.Object
- com.adyen.model.checkout.ThreeDSecureData

public class ThreeDSecureData
extends Object

ThreeDSecureData

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ThreeDSecureData.AuthenticationResponseEnum`	In 3D Secure 1, the authentication response if the shopper was redirected.
`static class`	`ThreeDSecureData.ChallengeCancelEnum`	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
`static class`	`ThreeDSecureData.DirectoryResponseEnum`	In 3D Secure 1, this is the enrollment response from the 3D directory server.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AUTHENTICATION_RESPONSE`
`static String`	`JSON_PROPERTY_CAVV`
`static String`	`JSON_PROPERTY_CAVV_ALGORITHM`
`static String`	`JSON_PROPERTY_CHALLENGE_CANCEL`
`static String`	`JSON_PROPERTY_DIRECTORY_RESPONSE`
`static String`	`JSON_PROPERTY_DS_TRANS_I_D`
`static String`	`JSON_PROPERTY_ECI`
`static String`	`JSON_PROPERTY_RISK_SCORE`
`static String`	`JSON_PROPERTY_THREE_D_S_VERSION`
`static String`	`JSON_PROPERTY_TOKEN_AUTHENTICATION_VERIFICATION_VALUE`
`static String`	`JSON_PROPERTY_TRANS_STATUS_REASON`
`static String`	`JSON_PROPERTY_XID`

Constructor Summary

Constructors
Constructor Description

ThreeDSecureData()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ThreeDSecureData`	`authenticationResponse(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)`	In 3D Secure 1, the authentication response if the shopper was redirected.
`ThreeDSecureData`	`cavv(byte[] cavv)`	The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
`ThreeDSecureData`	`cavvAlgorithm(String cavvAlgorithm)`	The CAVV algorithm used.
`ThreeDSecureData`	`challengeCancel(ThreeDSecureData.ChallengeCancelEnum challengeCancel)`	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
`ThreeDSecureData`	`directoryResponse(ThreeDSecureData.DirectoryResponseEnum directoryResponse)`	In 3D Secure 1, this is the enrollment response from the 3D directory server.
`ThreeDSecureData`	`dsTransID(String dsTransID)`	Supported for 3D Secure 2.
`ThreeDSecureData`	`eci(String eci)`	The electronic commerce indicator.
`boolean`	`equals(Object o)`	Return true if this ThreeDSecureData object is equal to o.
`static ThreeDSecureData`	`fromJson(String jsonString)`	Create an instance of ThreeDSecureData given an JSON string
`ThreeDSecureData.AuthenticationResponseEnum`	`getAuthenticationResponse()`	In 3D Secure 1, the authentication response if the shopper was redirected.
`byte[]`	`getCavv()`	The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
`String`	`getCavvAlgorithm()`	The CAVV algorithm used.
`ThreeDSecureData.ChallengeCancelEnum`	`getChallengeCancel()`	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
`ThreeDSecureData.DirectoryResponseEnum`	`getDirectoryResponse()`	In 3D Secure 1, this is the enrollment response from the 3D directory server.
`String`	`getDsTransID()`	Supported for 3D Secure 2.
`String`	`getEci()`	The electronic commerce indicator.
`String`	`getRiskScore()`	Risk score calculated by Directory Server (DS).
`String`	`getThreeDSVersion()`	The version of the 3D Secure protocol.
`byte[]`	`getTokenAuthenticationVerificationValue()`	Network token authentication verification value (TAVV).
`String`	`getTransStatusReason()`	Provides information on why the `transStatus` field has the specified value.
`byte[]`	`getXid()`	Supported for 3D Secure 1.
`int`	`hashCode()`
`ThreeDSecureData`	`riskScore(String riskScore)`	Risk score calculated by Directory Server (DS).
`void`	`setAuthenticationResponse(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)`	In 3D Secure 1, the authentication response if the shopper was redirected.
`void`	`setCavv(byte[] cavv)`	The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
`void`	`setCavvAlgorithm(String cavvAlgorithm)`	The CAVV algorithm used.
`void`	`setChallengeCancel(ThreeDSecureData.ChallengeCancelEnum challengeCancel)`	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
`void`	`setDirectoryResponse(ThreeDSecureData.DirectoryResponseEnum directoryResponse)`	In 3D Secure 1, this is the enrollment response from the 3D directory server.
`void`	`setDsTransID(String dsTransID)`	Supported for 3D Secure 2.
`void`	`setEci(String eci)`	The electronic commerce indicator.
`void`	`setRiskScore(String riskScore)`	Risk score calculated by Directory Server (DS).
`void`	`setThreeDSVersion(String threeDSVersion)`	The version of the 3D Secure protocol.
`void`	`setTokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)`	Network token authentication verification value (TAVV).
`void`	`setTransStatusReason(String transStatusReason)`	Provides information on why the `transStatus` field has the specified value.
`void`	`setXid(byte[] xid)`	Supported for 3D Secure 1.
`ThreeDSecureData`	`threeDSVersion(String threeDSVersion)`	The version of the 3D Secure protocol.
`String`	`toJson()`	Convert an instance of ThreeDSecureData to an JSON string
`ThreeDSecureData`	`tokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)`	Network token authentication verification value (TAVV).
`String`	`toString()`
`ThreeDSecureData`	`transStatusReason(String transStatusReason)`	Provides information on why the `transStatus` field has the specified value.
`ThreeDSecureData`	`xid(byte[] xid)`	Supported for 3D Secure 1.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_AUTHENTICATION_RESPONSE
```
public static final String JSON_PROPERTY_AUTHENTICATION_RESPONSE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CAVV
```
public static final String JSON_PROPERTY_CAVV
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CAVV_ALGORITHM
```
public static final String JSON_PROPERTY_CAVV_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CHALLENGE_CANCEL
```
public static final String JSON_PROPERTY_CHALLENGE_CANCEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DIRECTORY_RESPONSE
```
public static final String JSON_PROPERTY_DIRECTORY_RESPONSE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DS_TRANS_I_D
```
public static final String JSON_PROPERTY_DS_TRANS_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ECI
```
public static final String JSON_PROPERTY_ECI
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RISK_SCORE
```
public static final String JSON_PROPERTY_RISK_SCORE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THREE_D_S_VERSION
```
public static final String JSON_PROPERTY_THREE_D_S_VERSION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOKEN_AUTHENTICATION_VERIFICATION_VALUE
```
public static final String JSON_PROPERTY_TOKEN_AUTHENTICATION_VERIFICATION_VALUE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRANS_STATUS_REASON
```
public static final String JSON_PROPERTY_TRANS_STATUS_REASON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_XID
```
public static final String JSON_PROPERTY_XID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ThreeDSecureData
```
public ThreeDSecureData()
```
- Method Detail
  - authenticationResponse
```
public ThreeDSecureData authenticationResponse(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)
```
    In 3D Secure 1, the authentication response if the shopper was redirected. In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
    
    Parameters:
    
    authenticationResponse -
    
    Returns:
    
    the current ThreeDSecureData instance, allowing for method chaining
  - getAuthenticationResponse
```
public ThreeDSecureData.AuthenticationResponseEnum getAuthenticationResponse()
```
    In 3D Secure 1, the authentication response if the shopper was redirected. In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
    
    Returns:
    
    authenticationResponse
  - setAuthenticationResponse
```
public void setAuthenticationResponse(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)
```
    In 3D Secure 1, the authentication response if the shopper was redirected. In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
    
    Parameters:
    
    authenticationResponse -
  - cavv
```
public ThreeDSecureData cavv(byte[] cavv)
```
    The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
    
    Parameters:
    
    cavv -
    
    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
  - setCavv
```
public void setCavv(byte[] cavv)
```
    The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
    
    Parameters:
    
    cavv -
  - cavvAlgorithm
```
public ThreeDSecureData cavvAlgorithm(String cavvAlgorithm)
```
    The CAVV algorithm used. Include this only for 3D Secure 1.
    
    Parameters:
    
    cavvAlgorithm -
    
    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
  - setCavvAlgorithm
```
public void setCavvAlgorithm(String cavvAlgorithm)
```
    The CAVV algorithm used. Include this only for 3D Secure 1.
    
    Parameters:
    
    cavvAlgorithm -
  - 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 -
    
    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
  - 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 -
  - directoryResponse
```
public ThreeDSecureData directoryResponse(ThreeDSecureData.DirectoryResponseEnum directoryResponse)
```
    In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`.
    
    Parameters:
    
    directoryResponse -
    
    Returns:
    
    the current ThreeDSecureData instance, allowing for method chaining
  - getDirectoryResponse
```
public ThreeDSecureData.DirectoryResponseEnum getDirectoryResponse()
```
    In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`.
    
    Returns:
    
    directoryResponse
  - setDirectoryResponse
```
public void setDirectoryResponse(ThreeDSecureData.DirectoryResponseEnum directoryResponse)
```
    In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`.
    
    Parameters:
    
    directoryResponse -
  - 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 -
    
    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
  - 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 -
  - eci
```
public ThreeDSecureData eci(String eci)
```
    The electronic commerce indicator.
    
    Parameters:
    
    eci -
    
    Returns:
    
    the current ThreeDSecureData instance, allowing for method chaining
  - getEci
```
public String getEci()
```
    The electronic commerce indicator.
    
    Returns:
    
    eci
  - setEci
```
public void setEci(String eci)
```
    The electronic commerce indicator.
    
    Parameters:
    
    eci -
  - riskScore
```
public ThreeDSecureData riskScore(String riskScore)
```
    Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.
    
    Parameters:
    
    riskScore -
    
    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
  - setRiskScore
```
public void setRiskScore(String riskScore)
```
    Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.
    
    Parameters:
    
    riskScore -
  - threeDSVersion
```
public ThreeDSecureData threeDSVersion(String threeDSVersion)
```
    The version of the 3D Secure protocol.
    
    Parameters:
    
    threeDSVersion -
    
    Returns:
    
    the current ThreeDSecureData instance, allowing for method chaining
  - getThreeDSVersion
```
public String getThreeDSVersion()
```
    The version of the 3D Secure protocol.
    
    Returns:
    
    threeDSVersion
  - setThreeDSVersion
```
public void setThreeDSVersion(String threeDSVersion)
```
    The version of the 3D Secure protocol.
    
    Parameters:
    
    threeDSVersion -
  - tokenAuthenticationVerificationValue
```
public ThreeDSecureData tokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)
```
    Network token authentication verification value (TAVV). The network token cryptogram.
    
    Parameters:
    
    tokenAuthenticationVerificationValue -
    
    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
  - setTokenAuthenticationVerificationValue
```
public void setTokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)
```
    Network token authentication verification value (TAVV). The network token cryptogram.
    
    Parameters:
    
    tokenAuthenticationVerificationValue -
  - 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 -
    
    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
  - 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 -
  - xid
```
public ThreeDSecureData xid(byte[] xid)
```
    Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
    
    Parameters:
    
    xid -
    
    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
  - setXid
```
public void setXid(byte[] xid)
```
    Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
    
    Parameters:
    
    xid -
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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

Class ThreeDSecureData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AUTHENTICATION_RESPONSE

JSON_PROPERTY_CAVV

JSON_PROPERTY_CAVV_ALGORITHM

JSON_PROPERTY_CHALLENGE_CANCEL

JSON_PROPERTY_DIRECTORY_RESPONSE

JSON_PROPERTY_DS_TRANS_I_D

JSON_PROPERTY_ECI

JSON_PROPERTY_RISK_SCORE

JSON_PROPERTY_THREE_D_S_VERSION

JSON_PROPERTY_TOKEN_AUTHENTICATION_VERIFICATION_VALUE

JSON_PROPERTY_TRANS_STATUS_REASON

JSON_PROPERTY_XID

Constructor Detail

ThreeDSecureData

Method Detail

authenticationResponse

getAuthenticationResponse

setAuthenticationResponse

cavv

getCavv

setCavv

cavvAlgorithm

getCavvAlgorithm

setCavvAlgorithm

challengeCancel

getChallengeCancel

setChallengeCancel

directoryResponse

getDirectoryResponse

setDirectoryResponse

dsTransID

getDsTransID

setDsTransID

eci

getEci

setEci

riskScore

getRiskScore

setRiskScore

threeDSVersion

getThreeDSVersion

setThreeDSVersion

tokenAuthenticationVerificationValue

getTokenAuthenticationVerificationValue

setTokenAuthenticationVerificationValue

transStatusReason

getTransStatusReason

setTransStatusReason

xid

getXid

setXid

equals

hashCode

toString

fromJson

toJson