Constructor Detail

Method Detail

• methodType

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder methodType(AuthenticationRetrieveResponse.ChallengeMetadata.MethodType methodType)

  The type of challenge method used for authentication.

• methodType

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder methodType(JsonField<AuthenticationRetrieveResponse.ChallengeMetadata.MethodType> methodType)

  Sets Builder.methodType to an arbitrary JSON value.

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

• status

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder status(AuthenticationRetrieveResponse.ChallengeMetadata.Status status)

  Indicates the status of the challenge

  • SUCCESS - Cardholder completed the challenge successfully

  • PENDING - Challenge was issued to the cardholder and was not completed yet

  • SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the provided phone number. Relevant only for SMS_OTP method

  • CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the given challenge TTL

  • CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting "cancel" on the challenge UI

  • CANCELED_OOB - Cardholder canceled the challenge out of band

  • ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an incorrect OTP more than the allowed number of times or requesting a new OTP more than the allowed number of times

  • ABORTED - Merchant aborted authentication after a challenge was requested

  • ERROR - The challenge failed for a reason different than those documented

• status

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder status(JsonField<AuthenticationRetrieveResponse.ChallengeMetadata.Status> status)

  Sets Builder.status to an arbitrary JSON value.

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

• phoneNumber

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder phoneNumber(String phoneNumber)

  The phone number used for delivering the OTP. Relevant only for SMS_OTP method.

• phoneNumber

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder phoneNumber(Optional<String> phoneNumber)

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

• phoneNumber

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder phoneNumber(JsonField<String> phoneNumber)

  Sets Builder.phoneNumber to an arbitrary JSON value.

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

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final AuthenticationRetrieveResponse.ChallengeMetadata.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final AuthenticationRetrieveResponse.ChallengeMetadata build()

  Returns an immutable instance of ChallengeMetadata.

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

  The following fields are required:

  .methodType()
  .status()