java.lang.Object
- com.adyen.model.payments.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.CustomTypeAdapterFactory`
`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 HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_AUTHENTICATION_RESPONSE`
`static String`	`SERIALIZED_NAME_CAVV`
`static String`	`SERIALIZED_NAME_CAVV_ALGORITHM`
`static String`	`SERIALIZED_NAME_CHALLENGE_CANCEL`
`static String`	`SERIALIZED_NAME_DIRECTORY_RESPONSE`
`static String`	`SERIALIZED_NAME_DS_TRANS_I_D`
`static String`	`SERIALIZED_NAME_ECI`
`static String`	`SERIALIZED_NAME_RISK_SCORE`
`static String`	`SERIALIZED_NAME_THREE_D_S_VERSION`
`static String`	`SERIALIZED_NAME_TOKEN_AUTHENTICATION_VERIFICATION_VALUE`
`static String`	`SERIALIZED_NAME_TRANS_STATUS_REASON`
`static String`	`SERIALIZED_NAME_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)`
`ThreeDSecureData`	`cavv(byte[] cavv)`
`ThreeDSecureData`	`cavvAlgorithm(String cavvAlgorithm)`
`ThreeDSecureData`	`challengeCancel(ThreeDSecureData.ChallengeCancelEnum challengeCancel)`
`ThreeDSecureData`	`directoryResponse(ThreeDSecureData.DirectoryResponseEnum directoryResponse)`
`ThreeDSecureData`	`dsTransID(String dsTransID)`
`ThreeDSecureData`	`eci(String eci)`
`boolean`	`equals(Object 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)`
`void`	`setAuthenticationResponse(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)`
`void`	`setCavv(byte[] cavv)`
`void`	`setCavvAlgorithm(String cavvAlgorithm)`
`void`	`setChallengeCancel(ThreeDSecureData.ChallengeCancelEnum challengeCancel)`
`void`	`setDirectoryResponse(ThreeDSecureData.DirectoryResponseEnum directoryResponse)`
`void`	`setDsTransID(String dsTransID)`
`void`	`setEci(String eci)`
`void`	`setRiskScore(String riskScore)`
`void`	`setThreeDSVersion(String threeDSVersion)`
`void`	`setTokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)`
`void`	`setTransStatusReason(String transStatusReason)`
`void`	`setXid(byte[] xid)`
`ThreeDSecureData`	`threeDSVersion(String threeDSVersion)`
`String`	`toJson()`	Convert an instance of ThreeDSecureData to an JSON string
`ThreeDSecureData`	`tokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)`
`String`	`toString()`
`ThreeDSecureData`	`transStatusReason(String transStatusReason)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)`	Validates the JSON Object and throws an exception if issues found
`ThreeDSecureData`	`xid(byte[] xid)`

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

- Field Detail
  - SERIALIZED_NAME_AUTHENTICATION_RESPONSE
```
public static final String SERIALIZED_NAME_AUTHENTICATION_RESPONSE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CAVV
```
public static final String SERIALIZED_NAME_CAVV
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CAVV_ALGORITHM
```
public static final String SERIALIZED_NAME_CAVV_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CHALLENGE_CANCEL
```
public static final String SERIALIZED_NAME_CHALLENGE_CANCEL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DIRECTORY_RESPONSE
```
public static final String SERIALIZED_NAME_DIRECTORY_RESPONSE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DS_TRANS_I_D
```
public static final String SERIALIZED_NAME_DS_TRANS_I_D
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ECI
```
public static final String SERIALIZED_NAME_ECI
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RISK_SCORE
```
public static final String SERIALIZED_NAME_RISK_SCORE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_THREE_D_S_VERSION
```
public static final String SERIALIZED_NAME_THREE_D_S_VERSION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOKEN_AUTHENTICATION_VERIFICATION_VALUE
```
public static final String SERIALIZED_NAME_TOKEN_AUTHENTICATION_VERIFICATION_VALUE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANS_STATUS_REASON
```
public static final String SERIALIZED_NAME_TRANS_STATUS_REASON
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_XID
```
public static final String SERIALIZED_NAME_XID
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - ThreeDSecureData
```
public ThreeDSecureData()
```
- Method Detail
  - authenticationResponse
```
public ThreeDSecureData authenticationResponse(ThreeDSecureData.AuthenticationResponseEnum authenticationResponse)
```
  - 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)
```
  - cavv
```
public ThreeDSecureData cavv(byte[] cavv)
```
  - getCavv
```
public byte[] getCavv()
```
    The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
    
    Returns:
    
    cavv
  - setCavv
```
public void setCavv(byte[] cavv)
```
  - cavvAlgorithm
```
public ThreeDSecureData cavvAlgorithm(String cavvAlgorithm)
```
  - getCavvAlgorithm
```
public String getCavvAlgorithm()
```
    The CAVV algorithm used. Include this only for 3D Secure 1.
    
    Returns:
    
    cavvAlgorithm
  - setCavvAlgorithm
```
public void setCavvAlgorithm(String cavvAlgorithm)
```
  - challengeCancel
```
public ThreeDSecureData challengeCancel(ThreeDSecureData.ChallengeCancelEnum challengeCancel)
```
  - 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)
```
  - directoryResponse
```
public ThreeDSecureData directoryResponse(ThreeDSecureData.DirectoryResponseEnum directoryResponse)
```
  - 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)
```
  - dsTransID
```
public ThreeDSecureData dsTransID(String dsTransID)
```
  - 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)
```
  - eci
```
public ThreeDSecureData eci(String eci)
```
  - getEci
```
public String getEci()
```
    The electronic commerce indicator.
    
    Returns:
    
    eci
  - setEci
```
public void setEci(String eci)
```
  - riskScore
```
public ThreeDSecureData riskScore(String riskScore)
```
  - getRiskScore
```
public String getRiskScore()
```
    Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.
    
    Returns:
    
    riskScore
  - setRiskScore
```
public void setRiskScore(String riskScore)
```
  - threeDSVersion
```
public ThreeDSecureData threeDSVersion(String threeDSVersion)
```
  - getThreeDSVersion
```
public String getThreeDSVersion()
```
    The version of the 3D Secure protocol.
    
    Returns:
    
    threeDSVersion
  - setThreeDSVersion
```
public void setThreeDSVersion(String threeDSVersion)
```
  - tokenAuthenticationVerificationValue
```
public ThreeDSecureData tokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)
```
  - getTokenAuthenticationVerificationValue
```
public byte[] getTokenAuthenticationVerificationValue()
```
    Network token authentication verification value (TAVV). The network token cryptogram.
    
    Returns:
    
    tokenAuthenticationVerificationValue
  - setTokenAuthenticationVerificationValue
```
public void setTokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue)
```
  - transStatusReason
```
public ThreeDSecureData transStatusReason(String transStatusReason)
```
  - 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)
```
  - xid
```
public ThreeDSecureData xid(byte[] xid)
```
  - 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)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to ThreeDSecureData
  - fromJson
```
public static ThreeDSecureData fromJson(String jsonString)
                                 throws IOException
```
    Create an instance of ThreeDSecureData given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of ThreeDSecureData
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to ThreeDSecureData
  - toJson
```
public String toJson()
```
    Convert an instance of ThreeDSecureData to an JSON string
    
    Returns:
    
    JSON string

Class ThreeDSecureData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_AUTHENTICATION_RESPONSE

SERIALIZED_NAME_CAVV

SERIALIZED_NAME_CAVV_ALGORITHM

SERIALIZED_NAME_CHALLENGE_CANCEL

SERIALIZED_NAME_DIRECTORY_RESPONSE

SERIALIZED_NAME_DS_TRANS_I_D

SERIALIZED_NAME_ECI

SERIALIZED_NAME_RISK_SCORE

SERIALIZED_NAME_THREE_D_S_VERSION

SERIALIZED_NAME_TOKEN_AUTHENTICATION_VERIFICATION_VALUE

SERIALIZED_NAME_TRANS_STATUS_REASON

SERIALIZED_NAME_XID

openapiFields

openapiRequiredFields

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

validateJsonObject

fromJson

toJson