Class AuthenticationRetrieveResponse.ChallengeMetadata
-
- All Implemented Interfaces:
public final class AuthenticationRetrieveResponse.ChallengeMetadataMetadata about the challenge method and delivery. Only present when a challenge is triggered.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAuthenticationRetrieveResponse.ChallengeMetadata.BuilderA builder for ChallengeMetadata.
public final classAuthenticationRetrieveResponse.ChallengeMetadata.MethodTypeThe type of challenge method used for authentication.
public final classAuthenticationRetrieveResponse.ChallengeMetadata.StatusIndicates 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
-
Method Summary
Modifier and Type Method Description final AuthenticationRetrieveResponse.ChallengeMetadata.MethodTypemethodType()The type of challenge method used for authentication. final AuthenticationRetrieveResponse.ChallengeMetadata.Statusstatus()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
final Optional<String>phoneNumber()The phone number used for delivering the OTP. final JsonField<AuthenticationRetrieveResponse.ChallengeMetadata.MethodType>_methodType()Returns the raw JSON value of methodType. final JsonField<AuthenticationRetrieveResponse.ChallengeMetadata.Status>_status()Returns the raw JSON value of status. final JsonField<String>_phoneNumber()Returns the raw JSON value of phoneNumber. final Map<String, JsonValue>_additionalProperties()final AuthenticationRetrieveResponse.ChallengeMetadata.BuildertoBuilder()final AuthenticationRetrieveResponse.ChallengeMetadatavalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AuthenticationRetrieveResponse.ChallengeMetadata.Builderbuilder()Returns a mutable builder for constructing an instance of ChallengeMetadata. -
-
Method Detail
-
methodType
final AuthenticationRetrieveResponse.ChallengeMetadata.MethodType methodType()
The type of challenge method used for authentication.
-
status
final 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
-
phoneNumber
final Optional<String> phoneNumber()
The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
-
_methodType
final JsonField<AuthenticationRetrieveResponse.ChallengeMetadata.MethodType> _methodType()
Returns the raw JSON value of methodType.
Unlike methodType, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<AuthenticationRetrieveResponse.ChallengeMetadata.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_phoneNumber
final JsonField<String> _phoneNumber()
Returns the raw JSON value of phoneNumber.
Unlike phoneNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final AuthenticationRetrieveResponse.ChallengeMetadata.Builder toBuilder()
-
validate
final AuthenticationRetrieveResponse.ChallengeMetadata validate()
-
builder
final static AuthenticationRetrieveResponse.ChallengeMetadata.Builder builder()
Returns a mutable builder for constructing an instance of ChallengeMetadata.
The following fields are required:
.methodType() .status()
-
-
-