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.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 StringJSON_PROPERTY_AUTHENTICATION_VALUEstatic StringJSON_PROPERTY_CAVV_ALGORITHMstatic StringJSON_PROPERTY_CHALLENGE_CANCELstatic StringJSON_PROPERTY_DS_TRANS_I_Dstatic StringJSON_PROPERTY_ECIstatic StringJSON_PROPERTY_EXEMPTION_INDICATORstatic StringJSON_PROPERTY_MESSAGE_VERSIONstatic StringJSON_PROPERTY_RISK_SCOREstatic StringJSON_PROPERTY_THREE_D_S_REQUESTOR_CHALLENGE_INDstatic StringJSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_Dstatic StringJSON_PROPERTY_TIMESTAMPstatic StringJSON_PROPERTY_TRANS_STATUSstatic StringJSON_PROPERTY_TRANS_STATUS_REASONstatic StringJSON_PROPERTY_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)The `authenticationValue` value as defined in the 3D Secure 2 specification.ThreeDS2ResultcavvAlgorithm(String cavvAlgorithm)The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.ThreeDS2ResultchallengeCancel(ThreeDS2Result.ChallengeCancelEnum challengeCancel)Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.ThreeDS2ResultdsTransID(String dsTransID)The `dsTransID` value as defined in the 3D Secure 2 specification.ThreeDS2Resulteci(String eci)The `eci` value as defined in the 3D Secure 2 specification.booleanequals(Object o)Return true if this ThreeDS2Result object is equal to o.ThreeDS2ResultexemptionIndicator(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied.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)The `messageVersion` value as defined in the 3D Secure 2 specification.ThreeDS2ResultriskScore(String riskScore)Risk score calculated by Cartes Bancaires Directory Server (DS).voidsetAuthenticationValue(String authenticationValue)The `authenticationValue` value as defined in the 3D Secure 2 specification.voidsetCavvAlgorithm(String cavvAlgorithm)The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.voidsetChallengeCancel(ThreeDS2Result.ChallengeCancelEnum challengeCancel)Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.voidsetDsTransID(String dsTransID)The `dsTransID` value as defined in the 3D Secure 2 specification.voidsetEci(String eci)The `eci` value as defined in the 3D Secure 2 specification.voidsetExemptionIndicator(ThreeDS2Result.ExemptionIndicatorEnum exemptionIndicator)Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied.voidsetMessageVersion(String messageVersion)The `messageVersion` value as defined in the 3D Secure 2 specification.voidsetRiskScore(String riskScore)Risk score calculated by Cartes Bancaires Directory Server (DS).voidsetThreeDSRequestorChallengeInd(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)Indicates whether a challenge is requested for this transaction.voidsetThreeDSServerTransID(String threeDSServerTransID)The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.voidsetTimestamp(String timestamp)The `timestamp` value of the 3D Secure 2 authentication.voidsetTransStatus(String transStatus)The `transStatus` value as defined in the 3D Secure 2 specification.voidsetTransStatusReason(String transStatusReason)Provides information on why the `transStatus` field has the specified value.voidsetWhiteListStatus(String whiteListStatus)The `whiteListStatus` value as defined in the 3D Secure 2 specification.ThreeDS2ResultthreeDSRequestorChallengeInd(ThreeDS2Result.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)Indicates whether a challenge is requested for this transaction.ThreeDS2ResultthreeDSServerTransID(String threeDSServerTransID)The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.ThreeDS2Resulttimestamp(String timestamp)The `timestamp` value of the 3D Secure 2 authentication.StringtoJson()Convert an instance of ThreeDS2Result to an JSON stringStringtoString()ThreeDS2ResulttransStatus(String transStatus)The `transStatus` value as defined in the 3D Secure 2 specification.ThreeDS2ResulttransStatusReason(String transStatusReason)Provides information on why the `transStatus` field has the specified value.ThreeDS2ResultwhiteListStatus(String whiteListStatus)The `whiteListStatus` value as defined in the 3D Secure 2 specification.
-
-
-
Field Detail
-
JSON_PROPERTY_AUTHENTICATION_VALUE
public static final String JSON_PROPERTY_AUTHENTICATION_VALUE
- 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_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_EXEMPTION_INDICATOR
public static final String JSON_PROPERTY_EXEMPTION_INDICATOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MESSAGE_VERSION
public static final String JSON_PROPERTY_MESSAGE_VERSION
- 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_REQUESTOR_CHALLENGE_IND
public static final String JSON_PROPERTY_THREE_D_S_REQUESTOR_CHALLENGE_IND
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D
public static final String JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TIMESTAMP
public static final String JSON_PROPERTY_TIMESTAMP
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRANS_STATUS
public static final String JSON_PROPERTY_TRANS_STATUS
- 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_WHITE_LIST_STATUS
public static final String JSON_PROPERTY_WHITE_LIST_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
authenticationValue
public ThreeDS2Result authenticationValue(String authenticationValue)
The `authenticationValue` value as defined in the 3D Secure 2 specification.- Parameters:
authenticationValue-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getAuthenticationValue
public String getAuthenticationValue()
The `authenticationValue` value as defined in the 3D Secure 2 specification.- Returns:
- authenticationValue
-
setAuthenticationValue
public void setAuthenticationValue(String authenticationValue)
The `authenticationValue` value as defined in the 3D Secure 2 specification.- Parameters:
authenticationValue-
-
cavvAlgorithm
public ThreeDS2Result cavvAlgorithm(String cavvAlgorithm)
The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.- Parameters:
cavvAlgorithm-- Returns:
- the current
ThreeDS2Resultinstance, 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
-
setCavvAlgorithm
public void setCavvAlgorithm(String cavvAlgorithm)
The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.- Parameters:
cavvAlgorithm-
-
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-- Returns:
- the current
ThreeDS2Resultinstance, 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
-
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-
-
dsTransID
public ThreeDS2Result dsTransID(String dsTransID)
The `dsTransID` value as defined in the 3D Secure 2 specification.- Parameters:
dsTransID-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getDsTransID
public String getDsTransID()
The `dsTransID` value as defined in the 3D Secure 2 specification.- Returns:
- dsTransID
-
setDsTransID
public void setDsTransID(String dsTransID)
The `dsTransID` value as defined in the 3D Secure 2 specification.- Parameters:
dsTransID-
-
eci
public ThreeDS2Result eci(String eci)
The `eci` value as defined in the 3D Secure 2 specification.- Parameters:
eci-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getEci
public String getEci()
The `eci` value as defined in the 3D Secure 2 specification.- Returns:
- eci
-
setEci
public void setEci(String eci)
The `eci` value as defined in the 3D Secure 2 specification.- Parameters:
eci-
-
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-- Returns:
- the current
ThreeDS2Resultinstance, 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
-
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-
-
messageVersion
public ThreeDS2Result messageVersion(String messageVersion)
The `messageVersion` value as defined in the 3D Secure 2 specification.- Parameters:
messageVersion-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getMessageVersion
public String getMessageVersion()
The `messageVersion` value as defined in the 3D Secure 2 specification.- Returns:
- messageVersion
-
setMessageVersion
public void setMessageVersion(String messageVersion)
The `messageVersion` value as defined in the 3D Secure 2 specification.- Parameters:
messageVersion-
-
riskScore
public ThreeDS2Result riskScore(String riskScore)
Risk score calculated by Cartes Bancaires Directory Server (DS).- Parameters:
riskScore-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getRiskScore
public String getRiskScore()
Risk score calculated by Cartes Bancaires Directory Server (DS).- Returns:
- riskScore
-
setRiskScore
public void setRiskScore(String riskScore)
Risk score calculated by Cartes Bancaires Directory Server (DS).- Parameters:
riskScore-
-
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-- Returns:
- the current
ThreeDS2Resultinstance, 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
-
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-
-
threeDSServerTransID
public ThreeDS2Result threeDSServerTransID(String threeDSServerTransID)
The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.- Parameters:
threeDSServerTransID-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getThreeDSServerTransID
public String getThreeDSServerTransID()
The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.- Returns:
- threeDSServerTransID
-
setThreeDSServerTransID
public void setThreeDSServerTransID(String threeDSServerTransID)
The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.- Parameters:
threeDSServerTransID-
-
timestamp
public ThreeDS2Result timestamp(String timestamp)
The `timestamp` value of the 3D Secure 2 authentication.- Parameters:
timestamp-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getTimestamp
public String getTimestamp()
The `timestamp` value of the 3D Secure 2 authentication.- Returns:
- timestamp
-
setTimestamp
public void setTimestamp(String timestamp)
The `timestamp` value of the 3D Secure 2 authentication.- Parameters:
timestamp-
-
transStatus
public ThreeDS2Result transStatus(String transStatus)
The `transStatus` value as defined in the 3D Secure 2 specification.- Parameters:
transStatus-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getTransStatus
public String getTransStatus()
The `transStatus` value as defined in the 3D Secure 2 specification.- Returns:
- transStatus
-
setTransStatus
public void setTransStatus(String transStatus)
The `transStatus` value as defined in the 3D Secure 2 specification.- Parameters:
transStatus-
-
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-- Returns:
- the current
ThreeDS2Resultinstance, 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-
-
whiteListStatus
public ThreeDS2Result whiteListStatus(String whiteListStatus)
The `whiteListStatus` value as defined in the 3D Secure 2 specification.- Parameters:
whiteListStatus-- Returns:
- the current
ThreeDS2Resultinstance, allowing for method chaining
-
getWhiteListStatus
public String getWhiteListStatus()
The `whiteListStatus` value as defined in the 3D Secure 2 specification.- Returns:
- whiteListStatus
-
setWhiteListStatus
public void setWhiteListStatus(String whiteListStatus)
The `whiteListStatus` value as defined in the 3D Secure 2 specification.- Parameters:
whiteListStatus-
-
equals
public boolean equals(Object o)
Return true if this ThreeDS2Result object is equal to o.
-
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
-
-