Constructor Detail

Method Detail

• token

   final AuthenticationRetrieveResponse.Builder token(String token)

  Globally unique identifier for the 3DS authentication. Permitted values: 36-digit version 4 UUID (including hyphens).

• token

   final AuthenticationRetrieveResponse.Builder token(JsonField<String> token)

  Sets Builder.token to an arbitrary JSON value.

  You should usually call Builder.token with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• accountType

   final AuthenticationRetrieveResponse.Builder accountType(AuthenticationRetrieveResponse.AccountType accountType)

  Type of account/card that is being used for the transaction. Maps to EMV 3DS field acctType.

• accountType

   final AuthenticationRetrieveResponse.Builder accountType(Optional<AuthenticationRetrieveResponse.AccountType> accountType)

  Alias for calling Builder.accountType with accountType.orElse(null).

• accountType

   final AuthenticationRetrieveResponse.Builder accountType(JsonField<AuthenticationRetrieveResponse.AccountType> accountType)

  Sets Builder.accountType to an arbitrary JSON value.

  You should usually call Builder.accountType with a well-typed AccountType value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• authenticationResult

   final AuthenticationRetrieveResponse.Builder authenticationResult(AuthenticationRetrieveResponse.AuthenticationResult authenticationResult)

  Indicates the outcome of the 3DS authentication process.

• authenticationResult

   final AuthenticationRetrieveResponse.Builder authenticationResult(JsonField<AuthenticationRetrieveResponse.AuthenticationResult> authenticationResult)

  Sets Builder.authenticationResult to an arbitrary JSON value.

  You should usually call Builder.authenticationResult with a well-typed AuthenticationResult value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• cardExpiryCheck

   final AuthenticationRetrieveResponse.Builder cardExpiryCheck(AuthenticationRetrieveResponse.CardExpiryCheck cardExpiryCheck)

  Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date.

• cardExpiryCheck

   final AuthenticationRetrieveResponse.Builder cardExpiryCheck(JsonField<AuthenticationRetrieveResponse.CardExpiryCheck> cardExpiryCheck)

  Sets Builder.cardExpiryCheck to an arbitrary JSON value.

  You should usually call Builder.cardExpiryCheck with a well-typed CardExpiryCheck value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• cardToken

   final AuthenticationRetrieveResponse.Builder cardToken(String cardToken)

  Globally unique identifier for the card on which the 3DS authentication has occurred. Permitted values: 36-digit version 4 UUID (including hyphens).

• cardToken

   final AuthenticationRetrieveResponse.Builder cardToken(JsonField<String> cardToken)

  Sets Builder.cardToken to an arbitrary JSON value.

  You should usually call Builder.cardToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• cardholder

   final AuthenticationRetrieveResponse.Builder cardholder(AuthenticationRetrieveResponse.Cardholder cardholder)

  Object containing data about the cardholder provided during the transaction.

• cardholder

   final AuthenticationRetrieveResponse.Builder cardholder(JsonField<AuthenticationRetrieveResponse.Cardholder> cardholder)

  Sets Builder.cardholder to an arbitrary JSON value.

  You should usually call Builder.cardholder with a well-typed Cardholder value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• channel

   final AuthenticationRetrieveResponse.Builder channel(AuthenticationRetrieveResponse.Channel channel)

  Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.

• channel

   final AuthenticationRetrieveResponse.Builder channel(JsonField<AuthenticationRetrieveResponse.Channel> channel)

  Sets Builder.channel to an arbitrary JSON value.

  You should usually call Builder.channel with a well-typed Channel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• created

   final AuthenticationRetrieveResponse.Builder created(OffsetDateTime created)

  Date and time when the authentication was created in Lithic's system. Permitted values: Date string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.

• created

   final AuthenticationRetrieveResponse.Builder created(JsonField<OffsetDateTime> created)

  Sets Builder.created to an arbitrary JSON value.

  You should usually call Builder.created with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• merchant

   final AuthenticationRetrieveResponse.Builder merchant(AuthenticationRetrieveResponse.Merchant merchant)

  Object containing data about the merchant involved in the e-commerce transaction.

• merchant

   final AuthenticationRetrieveResponse.Builder merchant(JsonField<AuthenticationRetrieveResponse.Merchant> merchant)

  Sets Builder.merchant to an arbitrary JSON value.

  You should usually call Builder.merchant with a well-typed Merchant value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• messageCategory

   final AuthenticationRetrieveResponse.Builder messageCategory(AuthenticationRetrieveResponse.MessageCategory messageCategory)

  Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.

• messageCategory

   final AuthenticationRetrieveResponse.Builder messageCategory(JsonField<AuthenticationRetrieveResponse.MessageCategory> messageCategory)

  Sets Builder.messageCategory to an arbitrary JSON value.

  You should usually call Builder.messageCategory with a well-typed MessageCategory value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• threeDSRequestorChallengeIndicator

   final AuthenticationRetrieveResponse.Builder threeDSRequestorChallengeIndicator(AuthenticationRetrieveResponse.ThreeDSRequestorChallengeIndicator threeDSRequestorChallengeIndicator)

  Indicates whether a challenge is requested for this transaction

  • NO_PREFERENCE - No Preference

  • NO_CHALLENGE_REQUESTED - No Challenge Requested

  • CHALLENGE_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

• threeDSRequestorChallengeIndicator

   final AuthenticationRetrieveResponse.Builder threeDSRequestorChallengeIndicator(JsonField<AuthenticationRetrieveResponse.ThreeDSRequestorChallengeIndicator> threeDSRequestorChallengeIndicator)

  Sets Builder.threeDSRequestorChallengeIndicator to an arbitrary JSON value.

  You should usually call Builder.threeDSRequestorChallengeIndicator with a well-typed ThreeDSRequestorChallengeIndicator value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalData

   final AuthenticationRetrieveResponse.Builder additionalData(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).

• additionalData

   final AuthenticationRetrieveResponse.Builder additionalData(Optional<AuthenticationRetrieveResponse.AdditionalData> additionalData)

  Alias for calling Builder.additionalData with additionalData.orElse(null).

• additionalData

   final AuthenticationRetrieveResponse.Builder additionalData(JsonField<AuthenticationRetrieveResponse.AdditionalData> additionalData)

  Sets Builder.additionalData to an arbitrary JSON value.

  You should usually call Builder.additionalData with a well-typed AdditionalData value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• app

   final AuthenticationRetrieveResponse.Builder app(AuthenticationRetrieveResponse.App app)

  Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.

• app

   final AuthenticationRetrieveResponse.Builder app(Optional<AuthenticationRetrieveResponse.App> app)

  Alias for calling Builder.app with app.orElse(null).

• app

   final AuthenticationRetrieveResponse.Builder app(JsonField<AuthenticationRetrieveResponse.App> app)

  Sets Builder.app to an arbitrary JSON value.

  You should usually call Builder.app with a well-typed App value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• authenticationRequestType

   final AuthenticationRetrieveResponse.Builder authenticationRequestType(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.

• authenticationRequestType

   final AuthenticationRetrieveResponse.Builder authenticationRequestType(Optional<AuthenticationRetrieveResponse.AuthenticationRequestType> authenticationRequestType)

  Alias for calling Builder.authenticationRequestType with authenticationRequestType.orElse(null).

• authenticationRequestType

   final AuthenticationRetrieveResponse.Builder authenticationRequestType(JsonField<AuthenticationRetrieveResponse.AuthenticationRequestType> authenticationRequestType)

  Sets Builder.authenticationRequestType to an arbitrary JSON value.

  You should usually call Builder.authenticationRequestType with a well-typed AuthenticationRequestType value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• browser

   final AuthenticationRetrieveResponse.Builder browser(AuthenticationRetrieveResponse.Browser browser)

  Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.

• browser

   final AuthenticationRetrieveResponse.Builder browser(Optional<AuthenticationRetrieveResponse.Browser> browser)

  Alias for calling Builder.browser with browser.orElse(null).

• browser

   final AuthenticationRetrieveResponse.Builder browser(JsonField<AuthenticationRetrieveResponse.Browser> browser)

  Sets Builder.browser to an arbitrary JSON value.

  You should usually call Builder.browser with a well-typed Browser value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• challengeMetadata

   final AuthenticationRetrieveResponse.Builder challengeMetadata(AuthenticationRetrieveResponse.ChallengeMetadata challengeMetadata)

  Metadata about the challenge method and delivery. Only present when a challenge is triggered.

• challengeMetadata

   final AuthenticationRetrieveResponse.Builder challengeMetadata(Optional<AuthenticationRetrieveResponse.ChallengeMetadata> challengeMetadata)

  Alias for calling Builder.challengeMetadata with challengeMetadata.orElse(null).

• challengeMetadata

   final AuthenticationRetrieveResponse.Builder challengeMetadata(JsonField<AuthenticationRetrieveResponse.ChallengeMetadata> challengeMetadata)

  Sets Builder.challengeMetadata to an arbitrary JSON value.

  You should usually call Builder.challengeMetadata with a well-typed ChallengeMetadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• challengeOrchestratedBy

   final AuthenticationRetrieveResponse.Builder challengeOrchestratedBy(AuthenticationRetrieveResponse.ChallengeOrchestratedBy challengeOrchestratedBy)

  Entity that orchestrates the challenge. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request).

• challengeOrchestratedBy

   final AuthenticationRetrieveResponse.Builder challengeOrchestratedBy(Optional<AuthenticationRetrieveResponse.ChallengeOrchestratedBy> challengeOrchestratedBy)

  Alias for calling Builder.challengeOrchestratedBy with challengeOrchestratedBy.orElse(null).

• challengeOrchestratedBy

   final AuthenticationRetrieveResponse.Builder challengeOrchestratedBy(JsonField<AuthenticationRetrieveResponse.ChallengeOrchestratedBy> challengeOrchestratedBy)

  Sets Builder.challengeOrchestratedBy to an arbitrary JSON value.

  You should usually call Builder.challengeOrchestratedBy with a well-typed ChallengeOrchestratedBy value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• decisionMadeBy

   final AuthenticationRetrieveResponse.Builder decisionMadeBy(AuthenticationRetrieveResponse.DecisionMadeBy decisionMadeBy)

  Entity that made the authentication decision. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request).

• decisionMadeBy

   final AuthenticationRetrieveResponse.Builder decisionMadeBy(Optional<AuthenticationRetrieveResponse.DecisionMadeBy> decisionMadeBy)

  Alias for calling Builder.decisionMadeBy with decisionMadeBy.orElse(null).

• decisionMadeBy

   final AuthenticationRetrieveResponse.Builder decisionMadeBy(JsonField<AuthenticationRetrieveResponse.DecisionMadeBy> decisionMadeBy)

  Sets Builder.decisionMadeBy to an arbitrary JSON value.

  You should usually call Builder.decisionMadeBy with a well-typed DecisionMadeBy value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• threeRiRequestType

   final AuthenticationRetrieveResponse.Builder threeRiRequestType(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.

• threeRiRequestType

   final AuthenticationRetrieveResponse.Builder threeRiRequestType(Optional<AuthenticationRetrieveResponse.ThreeRiRequestType> threeRiRequestType)

  Alias for calling Builder.threeRiRequestType with threeRiRequestType.orElse(null).

• threeRiRequestType

   final AuthenticationRetrieveResponse.Builder threeRiRequestType(JsonField<AuthenticationRetrieveResponse.ThreeRiRequestType> threeRiRequestType)

  Sets Builder.threeRiRequestType to an arbitrary JSON value.

  You should usually call Builder.threeRiRequestType with a well-typed ThreeRiRequestType value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• transaction

   final AuthenticationRetrieveResponse.Builder transaction(AuthenticationRetrieveResponse.Transaction transaction)

  Object containing data about the e-commerce transaction for which the merchant is requesting authentication.

• transaction

   final AuthenticationRetrieveResponse.Builder transaction(Optional<AuthenticationRetrieveResponse.Transaction> transaction)

  Alias for calling Builder.transaction with transaction.orElse(null).

• transaction

   final AuthenticationRetrieveResponse.Builder transaction(JsonField<AuthenticationRetrieveResponse.Transaction> transaction)

  Sets Builder.transaction to an arbitrary JSON value.

  You should usually call Builder.transaction with a well-typed Transaction value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final AuthenticationRetrieveResponse.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final AuthenticationRetrieveResponse.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final AuthenticationRetrieveResponse.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final AuthenticationRetrieveResponse.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final AuthenticationRetrieveResponse.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final AuthenticationRetrieveResponse build()

  Returns an immutable instance of AuthenticationRetrieveResponse.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .token()
  .accountType()
  .authenticationResult()
  .cardExpiryCheck()
  .cardToken()
  .cardholder()
  .channel()
  .created()
  .merchant()
  .messageCategory()
  .threeDSRequestorChallengeIndicator()