Package com.adyen.model.checkout
Class ThreeDS2Result
- java.lang.Object
-
- com.adyen.model.checkout.ThreeDS2Result
-
public class ThreeDS2Result extends Object
ThreeDS2Result
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classThreeDS2Result.ChallengeCancelEnumIndicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.static classThreeDS2Result.CustomTypeAdapterFactorystatic classThreeDS2Result.ExemptionIndicatorEnumIndicates the exemption type that was applied by the issuer to the authentication, if exemption applied.static classThreeDS2Result.ThreeDSRequestorChallengeIndEnumIndicates whether a challenge is requested for this transaction.
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_AUTHENTICATION_VALUEstatic StringSERIALIZED_NAME_CAVV_ALGORITHMstatic StringSERIALIZED_NAME_CHALLENGE_CANCELstatic StringSERIALIZED_NAME_DS_TRANS_I_Dstatic StringSERIALIZED_NAME_ECIstatic StringSERIALIZED_NAME_EXEMPTION_INDICATORstatic StringSERIALIZED_NAME_MESSAGE_VERSIONstatic StringSERIALIZED_NAME_RISK_SCOREstatic StringSERIALIZED_NAME_THREE_D_S_REQUESTOR_CHALLENGE_INDstatic StringSERIALIZED_NAME_THREE_D_S_SERVER_TRANS_I_Dstatic StringSERIALIZED_NAME_TIMESTAMPstatic StringSERIALIZED_NAME_TRANS_STATUSstatic StringSERIALIZED_NAME_TRANS_STATUS_REASONstatic StringSERIALIZED_NAME_WHITE_LIST_STATUS
-
Constructor Summary
Constructors Constructor Description ThreeDS2Result()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ThreeDS2ResultauthenticationValue(String authenticationValue)ThreeDS2ResultcavvAlgorithm(String cavvAlgorithm)ThreeDS2ResultchallengeCancel(ThreeDS2Result.ChallengeCancelEnum challengeCancel)ThreeDS2ResultdsTransID(String dsTransID)ThreeDS2Resulteci(String eci)booleanequals(Object o)ThreeDS2ResultexemptionIndicator(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)static ThreeDS2ResultfromJson(String jsonString)Create an instance of ThreeDS2Result given an JSON stringStringgetAuthenticationValue()The `authenticationValue` value as defined in the 3D Secure 2 specification.StringgetCavvAlgorithm()The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.ThreeDS2Result.ChallengeCancelEnumgetChallengeCancel()Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.StringgetDsTransID()The `dsTransID` value as defined in the 3D Secure 2 specification.StringgetEci()The `eci` value as defined in the 3D Secure 2 specification.ThreeDS2Result.ExemptionIndicatorEnumgetExemptionIndicator()Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied.StringgetMessageVersion()The `messageVersion` value as defined in the 3D Secure 2 specification.StringgetRiskScore()Risk score calculated by Cartes Bancaires Directory Server (DS).ThreeDS2Result.ThreeDSRequestorChallengeIndEnumgetThreeDSRequestorChallengeInd()Indicates whether a challenge is requested for this transaction.StringgetThreeDSServerTransID()The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.StringgetTimestamp()The `timestamp` value of the 3D Secure 2 authentication.StringgetTransStatus()The `transStatus` value as defined in the 3D Secure 2 specification.StringgetTransStatusReason()Provides information on why the `transStatus` field has the specified value.StringgetWhiteListStatus()The `whiteListStatus` value as defined in the 3D Secure 2 specification.inthashCode()ThreeDS2ResultmessageVersion(String messageVersion)ThreeDS2ResultriskScore(String riskScore)voidsetAuthenticationValue(String authenticationValue)voidsetCavvAlgorithm(String cavvAlgorithm)voidsetChallengeCancel(ThreeDS2Result.ChallengeCancelEnum challengeCancel)voidsetDsTransID(String dsTransID)voidsetEci(String eci)voidsetExemptionIndicator(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)voidsetMessageVersion(String messageVersion)voidsetRiskScore(String riskScore)voidsetThreeDSRequestorChallengeInd(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)voidsetThreeDSServerTransID(String threeDSServerTransID)voidsetTimestamp(String timestamp)voidsetTransStatus(String transStatus)voidsetTransStatusReason(String transStatusReason)voidsetWhiteListStatus(String whiteListStatus)ThreeDS2ResultthreeDSRequestorChallengeInd(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)ThreeDS2ResultthreeDSServerTransID(String threeDSServerTransID)ThreeDS2Resulttimestamp(String timestamp)StringtoJson()Convert an instance of ThreeDS2Result to an JSON stringStringtoString()ThreeDS2ResulttransStatus(String transStatus)ThreeDS2ResulttransStatusReason(String transStatusReason)static voidvalidateJsonObject(com.google.gson.JsonObject jsonObj)static voidvalidateJsonObject(com.google.gson.JsonObject jsonObj, boolean strictValidation)Validates the JSON Object and throws an exception if issues foundThreeDS2ResultwhiteListStatus(String whiteListStatus)
-
-
-
Field Detail
-
SERIALIZED_NAME_AUTHENTICATION_VALUE
public static final String SERIALIZED_NAME_AUTHENTICATION_VALUE
- 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_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_EXEMPTION_INDICATOR
public static final String SERIALIZED_NAME_EXEMPTION_INDICATOR
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MESSAGE_VERSION
public static final String SERIALIZED_NAME_MESSAGE_VERSION
- 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_REQUESTOR_CHALLENGE_IND
public static final String SERIALIZED_NAME_THREE_D_S_REQUESTOR_CHALLENGE_IND
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_THREE_D_S_SERVER_TRANS_I_D
public static final String SERIALIZED_NAME_THREE_D_S_SERVER_TRANS_I_D
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TIMESTAMP
public static final String SERIALIZED_NAME_TIMESTAMP
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TRANS_STATUS
public static final String SERIALIZED_NAME_TRANS_STATUS
- 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_WHITE_LIST_STATUS
public static final String SERIALIZED_NAME_WHITE_LIST_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
authenticationValue
public ThreeDS2Result authenticationValue(String authenticationValue)
-
getAuthenticationValue
public String getAuthenticationValue()
The `authenticationValue` value as defined in the 3D Secure 2 specification.- Returns:
- authenticationValue
-
setAuthenticationValue
public void setAuthenticationValue(String authenticationValue)
-
cavvAlgorithm
public ThreeDS2Result cavvAlgorithm(String cavvAlgorithm)
-
getCavvAlgorithm
public String getCavvAlgorithm()
The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.- Returns:
- cavvAlgorithm
-
setCavvAlgorithm
public void setCavvAlgorithm(String cavvAlgorithm)
-
challengeCancel
public ThreeDS2Result challengeCancel(ThreeDS2Result.ChallengeCancelEnum challengeCancel)
-
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
-
setChallengeCancel
public void setChallengeCancel(ThreeDS2Result.ChallengeCancelEnum challengeCancel)
-
dsTransID
public ThreeDS2Result dsTransID(String dsTransID)
-
getDsTransID
public String getDsTransID()
The `dsTransID` value as defined in the 3D Secure 2 specification.- Returns:
- dsTransID
-
setDsTransID
public void setDsTransID(String dsTransID)
-
eci
public ThreeDS2Result eci(String eci)
-
getEci
public String getEci()
The `eci` value as defined in the 3D Secure 2 specification.- Returns:
- eci
-
setEci
public void setEci(String eci)
-
exemptionIndicator
public ThreeDS2Result exemptionIndicator(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)
-
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
-
setExemptionIndicator
public void setExemptionIndicator(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)
-
messageVersion
public ThreeDS2Result messageVersion(String messageVersion)
-
getMessageVersion
public String getMessageVersion()
The `messageVersion` value as defined in the 3D Secure 2 specification.- Returns:
- messageVersion
-
setMessageVersion
public void setMessageVersion(String messageVersion)
-
riskScore
public ThreeDS2Result riskScore(String riskScore)
-
getRiskScore
public String getRiskScore()
Risk score calculated by Cartes Bancaires Directory Server (DS).- Returns:
- riskScore
-
setRiskScore
public void setRiskScore(String riskScore)
-
threeDSRequestorChallengeInd
public ThreeDS2Result threeDSRequestorChallengeInd(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)
-
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
-
setThreeDSRequestorChallengeInd
public void setThreeDSRequestorChallengeInd(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)
-
threeDSServerTransID
public ThreeDS2Result threeDSServerTransID(String threeDSServerTransID)
-
getThreeDSServerTransID
public String getThreeDSServerTransID()
The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.- Returns:
- threeDSServerTransID
-
setThreeDSServerTransID
public void setThreeDSServerTransID(String threeDSServerTransID)
-
timestamp
public ThreeDS2Result timestamp(String timestamp)
-
getTimestamp
public String getTimestamp()
The `timestamp` value of the 3D Secure 2 authentication.- Returns:
- timestamp
-
setTimestamp
public void setTimestamp(String timestamp)
-
transStatus
public ThreeDS2Result transStatus(String transStatus)
-
getTransStatus
public String getTransStatus()
The `transStatus` value as defined in the 3D Secure 2 specification.- Returns:
- transStatus
-
setTransStatus
public void setTransStatus(String transStatus)
-
transStatusReason
public ThreeDS2Result 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)
-
whiteListStatus
public ThreeDS2Result whiteListStatus(String whiteListStatus)
-
getWhiteListStatus
public String getWhiteListStatus()
The `whiteListStatus` value as defined in the 3D Secure 2 specification.- Returns:
- whiteListStatus
-
setWhiteListStatus
public void setWhiteListStatus(String whiteListStatus)
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException- Throws:
IOException
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj, boolean strictValidation) throws IOExceptionValidates the JSON Object and throws an exception if issues found- Parameters:
jsonObj- JSON ObjectstrictValidation- reject (new) fields missing from the specifications- Throws:
IOException- if the JSON Object is invalid with respect to ThreeDS2Result
-
fromJson
public static ThreeDS2Result fromJson(String jsonString) throws IOException
Create an instance of ThreeDS2Result given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ThreeDS2Result
- Throws:
IOException- if the JSON string is invalid with respect to ThreeDS2Result
-
toJson
public String toJson()
Convert an instance of ThreeDS2Result to an JSON string- Returns:
- JSON string
-
-