Class AuthenticationRetrieveResponse.ChallengeMetadata.Status
-
- All Implemented Interfaces:
-
com.lithic.api.core.Enum
public final class AuthenticationRetrieveResponse.ChallengeMetadata.Status implements EnumIndicates 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumAuthenticationRetrieveResponse.ChallengeMetadata.Status.KnownAn enum containing Status's known values.
public enumAuthenticationRetrieveResponse.ChallengeMetadata.Status.ValueAn enum containing Status's known values, as well as an _UNKNOWN member.
An instance of Status can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusSUCCESSpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusPENDINGpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusSMS_DELIVERY_FAILEDpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusCARDHOLDER_TIMEOUTpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusCANCELED_VIA_CHALLENGE_UIpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusCANCELED_OOBpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusATTEMPTS_EXCEEDEDpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusABORTEDpublic final static AuthenticationRetrieveResponse.ChallengeMetadata.StatusERROR
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final AuthenticationRetrieveResponse.ChallengeMetadata.Status.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final AuthenticationRetrieveResponse.ChallengeMetadata.Status.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Returns this class instance's primitive wire representation. final AuthenticationRetrieveResponse.ChallengeMetadata.Statusvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AuthenticationRetrieveResponse.ChallengeMetadata.Statusof(String value)-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final AuthenticationRetrieveResponse.ChallengeMetadata.Status.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final AuthenticationRetrieveResponse.ChallengeMetadata.Status.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final AuthenticationRetrieveResponse.ChallengeMetadata.Status validate()
-
of
final static AuthenticationRetrieveResponse.ChallengeMetadata.Status of(String value)
-
-
-
-