Class AuthenticationRetrieveResponse
-
- All Implemented Interfaces:
public final class AuthenticationRetrieveResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAuthenticationRetrieveResponse.BuilderA builder for AuthenticationRetrieveResponse.
public final classAuthenticationRetrieveResponse.AccountTypeType of account/card that is being used for the transaction. Maps to EMV 3DS field
acctType.public final classAuthenticationRetrieveResponse.AuthenticationResultIndicates the outcome of the 3DS authentication process.
public final classAuthenticationRetrieveResponse.CardExpiryCheckIndicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date.
public final classAuthenticationRetrieveResponse.CardholderObject containing data about the cardholder provided during the transaction.
public final classAuthenticationRetrieveResponse.ChannelChannel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
public final classAuthenticationRetrieveResponse.MerchantObject containing data about the merchant involved in the e-commerce transaction.
public final classAuthenticationRetrieveResponse.MessageCategoryEither PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.
public final classAuthenticationRetrieveResponse.ThreeDSRequestorChallengeIndicatorIndicates whether a challenge is requested for this transaction
NO_PREFERENCE- No PreferenceNO_CHALLENGE_REQUESTED- No Challenge RequestedCHALLENGE_PREFERENCE- Challenge requested (3DS Requestor preference)CHALLENGE_MANDATE- Challenge requested (Mandate)NO_CHALLENGE_RISK_ALREADY_ASSESSED- No Challenge requested (Transactional risk analysis is already performed)DATA_SHARE_ONLY- No Challenge requested (Data Share Only)OTHER- Other indicators not captured by above. These are rarely used
public final classAuthenticationRetrieveResponse.AdditionalDataObject containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests).
public final classAuthenticationRetrieveResponse.AppObject containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.
public final classAuthenticationRetrieveResponse.AuthenticationRequestTypeType of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. Maps to EMV 3DS field threeDSRequestorAuthenticationInd.
public final classAuthenticationRetrieveResponse.BrowserObject containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.
public final classAuthenticationRetrieveResponse.ChallengeMetadataMetadata about the challenge method and delivery.
public final classAuthenticationRetrieveResponse.ChallengeOrchestratedByEntity that orchestrates the challenge.
public final classAuthenticationRetrieveResponse.DecisionMadeByEntity that made the authentication decision.
public final classAuthenticationRetrieveResponse.ThreeRiRequestTypeType of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. The most common example of this is where a merchant is authenticating before billing for a recurring transaction such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.
public final classAuthenticationRetrieveResponse.TransactionObject containing data about the e-commerce transaction for which the merchant is requesting authentication.
-
Method Summary
Modifier and Type Method Description final Stringtoken()Globally unique identifier for the 3DS authentication. final Optional<AuthenticationRetrieveResponse.AccountType>accountType()Type of account/card that is being used for the transaction. final AuthenticationRetrieveResponse.AuthenticationResultauthenticationResult()Indicates the outcome of the 3DS authentication process. final AuthenticationRetrieveResponse.CardExpiryCheckcardExpiryCheck()Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date. final StringcardToken()Globally unique identifier for the card on which the 3DS authentication has occurred. final AuthenticationRetrieveResponse.Cardholdercardholder()Object containing data about the cardholder provided during the transaction. final AuthenticationRetrieveResponse.Channelchannel()Channel in which the authentication occurs. final OffsetDateTimecreated()Date and time when the authentication was created in Lithic's system. final AuthenticationRetrieveResponse.Merchantmerchant()Object containing data about the merchant involved in the e-commerce transaction. final AuthenticationRetrieveResponse.MessageCategorymessageCategory()Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. final AuthenticationRetrieveResponse.ThreeDSRequestorChallengeIndicatorthreeDSRequestorChallengeIndicator()Indicates whether a challenge is requested for this transaction NO_PREFERENCE- No PreferenceNO_CHALLENGE_REQUESTED- No Challenge RequestedCHALLENGE_PREFERENCE- Challenge requested (3DS Requestor preference)CHALLENGE_MANDATE- Challenge requested (Mandate)NO_CHALLENGE_RISK_ALREADY_ASSESSED- No Challenge requested (Transactional risk analysis is already performed)DATA_SHARE_ONLY- No Challenge requested (Data Share Only)OTHER- Other indicators not captured by above. These are rarely used
final Optional<AuthenticationRetrieveResponse.AdditionalData>additionalData()Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests). final Optional<AuthenticationRetrieveResponse.App>app()Object containing data about the app used in the e-commerce transaction. final Optional<AuthenticationRetrieveResponse.AuthenticationRequestType>authenticationRequestType()Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. final Optional<AuthenticationRetrieveResponse.Browser>browser()Object containing data about the browser used in the e-commerce transaction. final Optional<AuthenticationRetrieveResponse.ChallengeMetadata>challengeMetadata()Metadata about the challenge method and delivery. final Optional<AuthenticationRetrieveResponse.ChallengeOrchestratedBy>challengeOrchestratedBy()Entity that orchestrates the challenge. final Optional<AuthenticationRetrieveResponse.DecisionMadeBy>decisionMadeBy()Entity that made the authentication decision. final Optional<AuthenticationRetrieveResponse.ThreeRiRequestType>threeRiRequestType()Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. final Optional<AuthenticationRetrieveResponse.Transaction>transaction()Object containing data about the e-commerce transaction for which the merchant is requesting authentication. final JsonField<String>_token()Globally unique identifier for the 3DS authentication. final JsonField<AuthenticationRetrieveResponse.AccountType>_accountType()Type of account/card that is being used for the transaction. final JsonField<AuthenticationRetrieveResponse.AuthenticationResult>_authenticationResult()Indicates the outcome of the 3DS authentication process. final JsonField<AuthenticationRetrieveResponse.CardExpiryCheck>_cardExpiryCheck()Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date. final JsonField<String>_cardToken()Globally unique identifier for the card on which the 3DS authentication has occurred. final JsonField<AuthenticationRetrieveResponse.Cardholder>_cardholder()Object containing data about the cardholder provided during the transaction. final JsonField<AuthenticationRetrieveResponse.Channel>_channel()Channel in which the authentication occurs. final JsonField<OffsetDateTime>_created()Date and time when the authentication was created in Lithic's system. final JsonField<AuthenticationRetrieveResponse.Merchant>_merchant()Object containing data about the merchant involved in the e-commerce transaction. final JsonField<AuthenticationRetrieveResponse.MessageCategory>_messageCategory()Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. final JsonField<AuthenticationRetrieveResponse.ThreeDSRequestorChallengeIndicator>_threeDSRequestorChallengeIndicator()Indicates whether a challenge is requested for this transaction NO_PREFERENCE- No PreferenceNO_CHALLENGE_REQUESTED- No Challenge RequestedCHALLENGE_PREFERENCE- Challenge requested (3DS Requestor preference)CHALLENGE_MANDATE- Challenge requested (Mandate)NO_CHALLENGE_RISK_ALREADY_ASSESSED- No Challenge requested (Transactional risk analysis is already performed)DATA_SHARE_ONLY- No Challenge requested (Data Share Only)OTHER- Other indicators not captured by above. These are rarely used
final JsonField<AuthenticationRetrieveResponse.AdditionalData>_additionalData()Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests). final JsonField<AuthenticationRetrieveResponse.App>_app()Object containing data about the app used in the e-commerce transaction. final JsonField<AuthenticationRetrieveResponse.AuthenticationRequestType>_authenticationRequestType()Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. final JsonField<AuthenticationRetrieveResponse.Browser>_browser()Object containing data about the browser used in the e-commerce transaction. final JsonField<AuthenticationRetrieveResponse.ChallengeMetadata>_challengeMetadata()Metadata about the challenge method and delivery. final JsonField<AuthenticationRetrieveResponse.ChallengeOrchestratedBy>_challengeOrchestratedBy()Entity that orchestrates the challenge. final JsonField<AuthenticationRetrieveResponse.DecisionMadeBy>_decisionMadeBy()Entity that made the authentication decision. final JsonField<AuthenticationRetrieveResponse.ThreeRiRequestType>_threeRiRequestType()Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. final JsonField<AuthenticationRetrieveResponse.Transaction>_transaction()Object containing data about the e-commerce transaction for which the merchant is requesting authentication. final Map<String, JsonValue>_additionalProperties()final AuthenticationRetrieveResponsevalidate()final AuthenticationRetrieveResponse.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AuthenticationRetrieveResponse.Builderbuilder()Returns a mutable builder for constructing an instance of AuthenticationRetrieveResponse. -
-
Method Detail
-
accountType
final Optional<AuthenticationRetrieveResponse.AccountType> accountType()
Type of account/card that is being used for the transaction. Maps to EMV 3DS field
acctType.
-
authenticationResult
final AuthenticationRetrieveResponse.AuthenticationResult authenticationResult()
Indicates the outcome of the 3DS authentication process.
-
cardExpiryCheck
final AuthenticationRetrieveResponse.CardExpiryCheck cardExpiryCheck()
Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date.
-
cardToken
final String cardToken()
Globally unique identifier for the card on which the 3DS authentication has occurred.
-
cardholder
final AuthenticationRetrieveResponse.Cardholder cardholder()
Object containing data about the cardholder provided during the transaction.
-
channel
final AuthenticationRetrieveResponse.Channel channel()
Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
-
created
final OffsetDateTime created()
Date and time when the authentication was created in Lithic's system.
-
merchant
final AuthenticationRetrieveResponse.Merchant merchant()
Object containing data about the merchant involved in the e-commerce transaction.
-
messageCategory
final AuthenticationRetrieveResponse.MessageCategory messageCategory()
Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.
-
threeDSRequestorChallengeIndicator
final AuthenticationRetrieveResponse.ThreeDSRequestorChallengeIndicator threeDSRequestorChallengeIndicator()
Indicates whether a challenge is requested for this transaction
NO_PREFERENCE- No PreferenceNO_CHALLENGE_REQUESTED- No Challenge RequestedCHALLENGE_PREFERENCE- Challenge requested (3DS Requestor preference)CHALLENGE_MANDATE- Challenge requested (Mandate)NO_CHALLENGE_RISK_ALREADY_ASSESSED- No Challenge requested (Transactional risk analysis is already performed)DATA_SHARE_ONLY- No Challenge requested (Data Share Only)OTHER- Other indicators not captured by above. These are rarely used
-
additionalData
final Optional<AuthenticationRetrieveResponse.AdditionalData> additionalData()
Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests).
-
app
final Optional<AuthenticationRetrieveResponse.App> app()
Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.
-
authenticationRequestType
final Optional<AuthenticationRetrieveResponse.AuthenticationRequestType> authenticationRequestType()
Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. Maps to EMV 3DS field threeDSRequestorAuthenticationInd.
-
browser
final Optional<AuthenticationRetrieveResponse.Browser> browser()
Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.
-
challengeMetadata
final Optional<AuthenticationRetrieveResponse.ChallengeMetadata> challengeMetadata()
Metadata about the challenge method and delivery.
-
challengeOrchestratedBy
final Optional<AuthenticationRetrieveResponse.ChallengeOrchestratedBy> challengeOrchestratedBy()
Entity that orchestrates the challenge.
-
decisionMadeBy
final Optional<AuthenticationRetrieveResponse.DecisionMadeBy> decisionMadeBy()
Entity that made the authentication decision.
-
threeRiRequestType
final Optional<AuthenticationRetrieveResponse.ThreeRiRequestType> threeRiRequestType()
Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. The most common example of this is where a merchant is authenticating before billing for a recurring transaction such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.
-
transaction
final Optional<AuthenticationRetrieveResponse.Transaction> transaction()
Object containing data about the e-commerce transaction for which the merchant is requesting authentication.
-
_accountType
final JsonField<AuthenticationRetrieveResponse.AccountType> _accountType()
Type of account/card that is being used for the transaction. Maps to EMV 3DS field
acctType.
-
_authenticationResult
final JsonField<AuthenticationRetrieveResponse.AuthenticationResult> _authenticationResult()
Indicates the outcome of the 3DS authentication process.
-
_cardExpiryCheck
final JsonField<AuthenticationRetrieveResponse.CardExpiryCheck> _cardExpiryCheck()
Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date.
-
_cardToken
final JsonField<String> _cardToken()
Globally unique identifier for the card on which the 3DS authentication has occurred.
-
_cardholder
final JsonField<AuthenticationRetrieveResponse.Cardholder> _cardholder()
Object containing data about the cardholder provided during the transaction.
-
_channel
final JsonField<AuthenticationRetrieveResponse.Channel> _channel()
Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
-
_created
final JsonField<OffsetDateTime> _created()
Date and time when the authentication was created in Lithic's system.
-
_merchant
final JsonField<AuthenticationRetrieveResponse.Merchant> _merchant()
Object containing data about the merchant involved in the e-commerce transaction.
-
_messageCategory
final JsonField<AuthenticationRetrieveResponse.MessageCategory> _messageCategory()
Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.
-
_threeDSRequestorChallengeIndicator
final JsonField<AuthenticationRetrieveResponse.ThreeDSRequestorChallengeIndicator> _threeDSRequestorChallengeIndicator()
Indicates whether a challenge is requested for this transaction
NO_PREFERENCE- No PreferenceNO_CHALLENGE_REQUESTED- No Challenge RequestedCHALLENGE_PREFERENCE- Challenge requested (3DS Requestor preference)CHALLENGE_MANDATE- Challenge requested (Mandate)NO_CHALLENGE_RISK_ALREADY_ASSESSED- No Challenge requested (Transactional risk analysis is already performed)DATA_SHARE_ONLY- No Challenge requested (Data Share Only)OTHER- Other indicators not captured by above. These are rarely used
-
_additionalData
final JsonField<AuthenticationRetrieveResponse.AdditionalData> _additionalData()
Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests).
-
_app
final JsonField<AuthenticationRetrieveResponse.App> _app()
Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.
-
_authenticationRequestType
final JsonField<AuthenticationRetrieveResponse.AuthenticationRequestType> _authenticationRequestType()
Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. Maps to EMV 3DS field threeDSRequestorAuthenticationInd.
-
_browser
final JsonField<AuthenticationRetrieveResponse.Browser> _browser()
Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.
-
_challengeMetadata
final JsonField<AuthenticationRetrieveResponse.ChallengeMetadata> _challengeMetadata()
Metadata about the challenge method and delivery.
-
_challengeOrchestratedBy
final JsonField<AuthenticationRetrieveResponse.ChallengeOrchestratedBy> _challengeOrchestratedBy()
Entity that orchestrates the challenge.
-
_decisionMadeBy
final JsonField<AuthenticationRetrieveResponse.DecisionMadeBy> _decisionMadeBy()
Entity that made the authentication decision.
-
_threeRiRequestType
final JsonField<AuthenticationRetrieveResponse.ThreeRiRequestType> _threeRiRequestType()
Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. The most common example of this is where a merchant is authenticating before billing for a recurring transaction such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.
-
_transaction
final JsonField<AuthenticationRetrieveResponse.Transaction> _transaction()
Object containing data about the e-commerce transaction for which the merchant is requesting authentication.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final AuthenticationRetrieveResponse validate()
-
toBuilder
final AuthenticationRetrieveResponse.Builder toBuilder()
-
builder
final static AuthenticationRetrieveResponse.Builder builder()
Returns a mutable builder for constructing an instance of AuthenticationRetrieveResponse.
The following fields are required:
.token() .accountType() .authenticationResult() .cardExpiryCheck() .cardToken() .cardholder() .channel() .created() .merchant() .messageCategory() .threeDSRequestorChallengeIndicator()
-
-
-