Package com.adyen.model.acswebhooks
Class AuthenticationInfo
- java.lang.Object
-
- com.adyen.model.acswebhooks.AuthenticationInfo
-
public class AuthenticationInfo extends Object
AuthenticationInfo
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAuthenticationInfo.ChallengeIndicatorEnumSpecifies a preference for receiving a challenge.static classAuthenticationInfo.DeviceChannelEnumIndicates the type of channel interface being used to initiate the transaction.static classAuthenticationInfo.ExemptionIndicatorEnumIndicates the exemption type that was applied to the authentication by the issuer, if exemption applied.static classAuthenticationInfo.MessageCategoryEnumIdentifies the category of the message for a specific use case.static classAuthenticationInfo.TransStatusEnumThe `transStatus` value as defined in the 3D Secure 2 specification.static classAuthenticationInfo.TransStatusReasonEnumProvides information on why the `transStatus` field has the specified value.static classAuthenticationInfo.TypeEnumThe type of authentication performed.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACS_TRANS_IDstatic StringJSON_PROPERTY_CHALLENGEstatic StringJSON_PROPERTY_CHALLENGE_INDICATORstatic StringJSON_PROPERTY_CREATED_ATstatic StringJSON_PROPERTY_DEVICE_CHANNELstatic StringJSON_PROPERTY_DS_TRANS_I_Dstatic StringJSON_PROPERTY_EXEMPTION_INDICATORstatic StringJSON_PROPERTY_IN_P_S_D2_SCOPEstatic StringJSON_PROPERTY_MESSAGE_CATEGORYstatic StringJSON_PROPERTY_MESSAGE_VERSIONstatic StringJSON_PROPERTY_RISK_SCOREstatic StringJSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_Dstatic StringJSON_PROPERTY_TRANS_STATUSstatic StringJSON_PROPERTY_TRANS_STATUS_REASONstatic StringJSON_PROPERTY_TYPE
-
Constructor Summary
Constructors Constructor Description AuthenticationInfo()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationInfoacsTransId(String acsTransId)Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.AuthenticationInfochallenge(ChallengeInfo challenge)challengeAuthenticationInfochallengeIndicator(AuthenticationInfo.ChallengeIndicatorEnum challengeIndicator)Specifies a preference for receiving a challenge.AuthenticationInfocreatedAt(OffsetDateTime createdAt)Date and time in UTC of the cardholder authentication.AuthenticationInfodeviceChannel(AuthenticationInfo.DeviceChannelEnum deviceChannel)Indicates the type of channel interface being used to initiate the transaction.AuthenticationInfodsTransID(String dsTransID)Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction.booleanequals(Object o)Return true if this AuthenticationInfo object is equal to o.AuthenticationInfoexemptionIndicator(AuthenticationInfo.ExemptionIndicatorEnum exemptionIndicator)Indicates the exemption type that was applied to the authentication by the issuer, if exemption applied.static AuthenticationInfofromJson(String jsonString)Create an instance of AuthenticationInfo given an JSON stringStringgetAcsTransId()Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.ChallengeInfogetChallenge()challengeAuthenticationInfo.ChallengeIndicatorEnumgetChallengeIndicator()Specifies a preference for receiving a challenge.OffsetDateTimegetCreatedAt()Date and time in UTC of the cardholder authentication.AuthenticationInfo.DeviceChannelEnumgetDeviceChannel()Indicates the type of channel interface being used to initiate the transaction.StringgetDsTransID()Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction.AuthenticationInfo.ExemptionIndicatorEnumgetExemptionIndicator()Indicates the exemption type that was applied to the authentication by the issuer, if exemption applied.BooleangetInPSD2Scope()Indicates if the purchase was in the PSD2 scope.AuthenticationInfo.MessageCategoryEnumgetMessageCategory()Identifies the category of the message for a specific use case.StringgetMessageVersion()The `messageVersion` value as defined in the 3D Secure 2 specification.IntegergetRiskScore()Risk score calculated from the transaction rules.StringgetThreeDSServerTransID()The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.AuthenticationInfo.TransStatusEnumgetTransStatus()The `transStatus` value as defined in the 3D Secure 2 specification.AuthenticationInfo.TransStatusReasonEnumgetTransStatusReason()Provides information on why the `transStatus` field has the specified value.AuthenticationInfo.TypeEnumgetType()The type of authentication performed.inthashCode()AuthenticationInfoinPSD2Scope(Boolean inPSD2Scope)Indicates if the purchase was in the PSD2 scope.AuthenticationInfomessageCategory(AuthenticationInfo.MessageCategoryEnum messageCategory)Identifies the category of the message for a specific use case.AuthenticationInfomessageVersion(String messageVersion)The `messageVersion` value as defined in the 3D Secure 2 specification.AuthenticationInforiskScore(Integer riskScore)Risk score calculated from the transaction rules.voidsetAcsTransId(String acsTransId)Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.voidsetChallenge(ChallengeInfo challenge)challengevoidsetChallengeIndicator(AuthenticationInfo.ChallengeIndicatorEnum challengeIndicator)Specifies a preference for receiving a challenge.voidsetCreatedAt(OffsetDateTime createdAt)Date and time in UTC of the cardholder authentication.voidsetDeviceChannel(AuthenticationInfo.DeviceChannelEnum deviceChannel)Indicates the type of channel interface being used to initiate the transaction.voidsetDsTransID(String dsTransID)Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction.voidsetExemptionIndicator(AuthenticationInfo.ExemptionIndicatorEnum exemptionIndicator)Indicates the exemption type that was applied to the authentication by the issuer, if exemption applied.voidsetInPSD2Scope(Boolean inPSD2Scope)Indicates if the purchase was in the PSD2 scope.voidsetMessageCategory(AuthenticationInfo.MessageCategoryEnum messageCategory)Identifies the category of the message for a specific use case.voidsetMessageVersion(String messageVersion)The `messageVersion` value as defined in the 3D Secure 2 specification.voidsetRiskScore(Integer riskScore)Risk score calculated from the transaction rules.voidsetThreeDSServerTransID(String threeDSServerTransID)The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.voidsetTransStatus(AuthenticationInfo.TransStatusEnum transStatus)The `transStatus` value as defined in the 3D Secure 2 specification.voidsetTransStatusReason(AuthenticationInfo.TransStatusReasonEnum transStatusReason)Provides information on why the `transStatus` field has the specified value.voidsetType(AuthenticationInfo.TypeEnum type)The type of authentication performed.AuthenticationInfothreeDSServerTransID(String threeDSServerTransID)The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.StringtoJson()Convert an instance of AuthenticationInfo to an JSON stringStringtoString()AuthenticationInfotransStatus(AuthenticationInfo.TransStatusEnum transStatus)The `transStatus` value as defined in the 3D Secure 2 specification.AuthenticationInfotransStatusReason(AuthenticationInfo.TransStatusReasonEnum transStatusReason)Provides information on why the `transStatus` field has the specified value.AuthenticationInfotype(AuthenticationInfo.TypeEnum type)The type of authentication performed.
-
-
-
Field Detail
-
JSON_PROPERTY_ACS_TRANS_ID
public static final String JSON_PROPERTY_ACS_TRANS_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CHALLENGE
public static final String JSON_PROPERTY_CHALLENGE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CHALLENGE_INDICATOR
public static final String JSON_PROPERTY_CHALLENGE_INDICATOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CREATED_AT
public static final String JSON_PROPERTY_CREATED_AT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DEVICE_CHANNEL
public static final String JSON_PROPERTY_DEVICE_CHANNEL
- 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_EXEMPTION_INDICATOR
public static final String JSON_PROPERTY_EXEMPTION_INDICATOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IN_P_S_D2_SCOPE
public static final String JSON_PROPERTY_IN_P_S_D2_SCOPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MESSAGE_CATEGORY
public static final String JSON_PROPERTY_MESSAGE_CATEGORY
- 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_SERVER_TRANS_I_D
public static final String JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D
- 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_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
acsTransId
public AuthenticationInfo acsTransId(String acsTransId)
Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.- Parameters:
acsTransId-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getAcsTransId
public String getAcsTransId()
Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.- Returns:
- acsTransId
-
setAcsTransId
public void setAcsTransId(String acsTransId)
Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.- Parameters:
acsTransId-
-
challenge
public AuthenticationInfo challenge(ChallengeInfo challenge)
challenge- Parameters:
challenge-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getChallenge
public ChallengeInfo getChallenge()
challenge- Returns:
- challenge
-
setChallenge
public void setChallenge(ChallengeInfo challenge)
challenge- Parameters:
challenge-
-
challengeIndicator
public AuthenticationInfo challengeIndicator(AuthenticationInfo.ChallengeIndicatorEnum challengeIndicator)
Specifies a preference for receiving a challenge. Possible values: * **01**: No preference * **02**: No challenge requested * **03**: Challenge requested (preference) * **04**: Challenge requested (mandate) * **05**: No challenge requested (transactional risk analysis is already performed) * **07**: No challenge requested (SCA is already performed) * **08**: No challenge requested (trusted beneficiaries exemption of no challenge required) * **09**: Challenge requested (trusted beneficiaries prompt requested if challenge required) * **80**: No challenge requested (secure corporate payment with Mastercard) * **82**: No challenge requested (secure corporate payment with Visa)- Parameters:
challengeIndicator-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getChallengeIndicator
public AuthenticationInfo.ChallengeIndicatorEnum getChallengeIndicator()
Specifies a preference for receiving a challenge. Possible values: * **01**: No preference * **02**: No challenge requested * **03**: Challenge requested (preference) * **04**: Challenge requested (mandate) * **05**: No challenge requested (transactional risk analysis is already performed) * **07**: No challenge requested (SCA is already performed) * **08**: No challenge requested (trusted beneficiaries exemption of no challenge required) * **09**: Challenge requested (trusted beneficiaries prompt requested if challenge required) * **80**: No challenge requested (secure corporate payment with Mastercard) * **82**: No challenge requested (secure corporate payment with Visa)- Returns:
- challengeIndicator
-
setChallengeIndicator
public void setChallengeIndicator(AuthenticationInfo.ChallengeIndicatorEnum challengeIndicator)
Specifies a preference for receiving a challenge. Possible values: * **01**: No preference * **02**: No challenge requested * **03**: Challenge requested (preference) * **04**: Challenge requested (mandate) * **05**: No challenge requested (transactional risk analysis is already performed) * **07**: No challenge requested (SCA is already performed) * **08**: No challenge requested (trusted beneficiaries exemption of no challenge required) * **09**: Challenge requested (trusted beneficiaries prompt requested if challenge required) * **80**: No challenge requested (secure corporate payment with Mastercard) * **82**: No challenge requested (secure corporate payment with Visa)- Parameters:
challengeIndicator-
-
createdAt
public AuthenticationInfo createdAt(OffsetDateTime createdAt)
Date and time in UTC of the cardholder authentication. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.- Parameters:
createdAt-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getCreatedAt
public OffsetDateTime getCreatedAt()
Date and time in UTC of the cardholder authentication. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.- Returns:
- createdAt
-
setCreatedAt
public void setCreatedAt(OffsetDateTime createdAt)
Date and time in UTC of the cardholder authentication. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.- Parameters:
createdAt-
-
deviceChannel
public AuthenticationInfo deviceChannel(AuthenticationInfo.DeviceChannelEnum deviceChannel)
Indicates the type of channel interface being used to initiate the transaction. Possible values: * **app** * **browser** * **3DSRequestorInitiated** (initiated by a merchant when the cardholder is not available)- Parameters:
deviceChannel-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getDeviceChannel
public AuthenticationInfo.DeviceChannelEnum getDeviceChannel()
Indicates the type of channel interface being used to initiate the transaction. Possible values: * **app** * **browser** * **3DSRequestorInitiated** (initiated by a merchant when the cardholder is not available)- Returns:
- deviceChannel
-
setDeviceChannel
public void setDeviceChannel(AuthenticationInfo.DeviceChannelEnum deviceChannel)
Indicates the type of channel interface being used to initiate the transaction. Possible values: * **app** * **browser** * **3DSRequestorInitiated** (initiated by a merchant when the cardholder is not available)- Parameters:
deviceChannel-
-
dsTransID
public AuthenticationInfo dsTransID(String dsTransID)
Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction.- Parameters:
dsTransID-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getDsTransID
public String getDsTransID()
Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction.- Returns:
- dsTransID
-
setDsTransID
public void setDsTransID(String dsTransID)
Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction.- Parameters:
dsTransID-
-
exemptionIndicator
public AuthenticationInfo exemptionIndicator(AuthenticationInfo.ExemptionIndicatorEnum exemptionIndicator)
Indicates the exemption type that was applied to the authentication by the issuer, if exemption applied. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** * **acquirerExemption** * **noExemptionApplied** * **visaDAFExemption**- Parameters:
exemptionIndicator-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getExemptionIndicator
public AuthenticationInfo.ExemptionIndicatorEnum getExemptionIndicator()
Indicates the exemption type that was applied to the authentication by the issuer, if exemption applied. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** * **acquirerExemption** * **noExemptionApplied** * **visaDAFExemption**- Returns:
- exemptionIndicator
-
setExemptionIndicator
public void setExemptionIndicator(AuthenticationInfo.ExemptionIndicatorEnum exemptionIndicator)
Indicates the exemption type that was applied to the authentication by the issuer, if exemption applied. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** * **acquirerExemption** * **noExemptionApplied** * **visaDAFExemption**- Parameters:
exemptionIndicator-
-
inPSD2Scope
public AuthenticationInfo inPSD2Scope(Boolean inPSD2Scope)
Indicates if the purchase was in the PSD2 scope.- Parameters:
inPSD2Scope-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getInPSD2Scope
public Boolean getInPSD2Scope()
Indicates if the purchase was in the PSD2 scope.- Returns:
- inPSD2Scope
-
setInPSD2Scope
public void setInPSD2Scope(Boolean inPSD2Scope)
Indicates if the purchase was in the PSD2 scope.- Parameters:
inPSD2Scope-
-
messageCategory
public AuthenticationInfo messageCategory(AuthenticationInfo.MessageCategoryEnum messageCategory)
Identifies the category of the message for a specific use case. Possible values: * **payment** * **nonPayment**- Parameters:
messageCategory-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getMessageCategory
public AuthenticationInfo.MessageCategoryEnum getMessageCategory()
Identifies the category of the message for a specific use case. Possible values: * **payment** * **nonPayment**- Returns:
- messageCategory
-
setMessageCategory
public void setMessageCategory(AuthenticationInfo.MessageCategoryEnum messageCategory)
Identifies the category of the message for a specific use case. Possible values: * **payment** * **nonPayment**- Parameters:
messageCategory-
-
messageVersion
public AuthenticationInfo messageVersion(String messageVersion)
The `messageVersion` value as defined in the 3D Secure 2 specification.- Parameters:
messageVersion-- Returns:
- the current
AuthenticationInfoinstance, 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 AuthenticationInfo riskScore(Integer riskScore)
Risk score calculated from the transaction rules.- Parameters:
riskScore-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getRiskScore
public Integer getRiskScore()
Risk score calculated from the transaction rules.- Returns:
- riskScore
-
setRiskScore
public void setRiskScore(Integer riskScore)
Risk score calculated from the transaction rules.- Parameters:
riskScore-
-
threeDSServerTransID
public AuthenticationInfo threeDSServerTransID(String threeDSServerTransID)
The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.- Parameters:
threeDSServerTransID-- Returns:
- the current
AuthenticationInfoinstance, 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-
-
transStatus
public AuthenticationInfo transStatus(AuthenticationInfo.TransStatusEnum transStatus)
The `transStatus` value as defined in the 3D Secure 2 specification. Possible values: * **Y**: Authentication / Account verification successful. * **N**: Not Authenticated / Account not verified. Transaction denied. * **U**: Authentication / Account verification could not be performed. * **I**: Informational Only / 3D Secure Requestor challenge preference acknowledged. * **R**: Authentication / Account verification rejected by the Issuer.- Parameters:
transStatus-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getTransStatus
public AuthenticationInfo.TransStatusEnum getTransStatus()
The `transStatus` value as defined in the 3D Secure 2 specification. Possible values: * **Y**: Authentication / Account verification successful. * **N**: Not Authenticated / Account not verified. Transaction denied. * **U**: Authentication / Account verification could not be performed. * **I**: Informational Only / 3D Secure Requestor challenge preference acknowledged. * **R**: Authentication / Account verification rejected by the Issuer.- Returns:
- transStatus
-
setTransStatus
public void setTransStatus(AuthenticationInfo.TransStatusEnum transStatus)
The `transStatus` value as defined in the 3D Secure 2 specification. Possible values: * **Y**: Authentication / Account verification successful. * **N**: Not Authenticated / Account not verified. Transaction denied. * **U**: Authentication / Account verification could not be performed. * **I**: Informational Only / 3D Secure Requestor challenge preference acknowledged. * **R**: Authentication / Account verification rejected by the Issuer.- Parameters:
transStatus-
-
transStatusReason
public AuthenticationInfo transStatusReason(AuthenticationInfo.TransStatusReasonEnum 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
AuthenticationInfoinstance, allowing for method chaining
-
getTransStatusReason
public AuthenticationInfo.TransStatusReasonEnum 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(AuthenticationInfo.TransStatusReasonEnum 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-
-
type
public AuthenticationInfo type(AuthenticationInfo.TypeEnum type)
The type of authentication performed. Possible values: * **frictionless** * **challenge**- Parameters:
type-- Returns:
- the current
AuthenticationInfoinstance, allowing for method chaining
-
getType
public AuthenticationInfo.TypeEnum getType()
The type of authentication performed. Possible values: * **frictionless** * **challenge**- Returns:
- type
-
setType
public void setType(AuthenticationInfo.TypeEnum type)
The type of authentication performed. Possible values: * **frictionless** * **challenge**- Parameters:
type-
-
equals
public boolean equals(Object o)
Return true if this AuthenticationInfo object is equal to o.
-
fromJson
public static AuthenticationInfo fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of AuthenticationInfo given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of AuthenticationInfo
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to AuthenticationInfo
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of AuthenticationInfo to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-