Package com.adyen.model.acswebhooks

Class ChallengeInfo

java.lang.Object

com.adyen.model.acswebhooks.ChallengeInfo

public class ChallengeInfo
extends Object

ChallengeInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChallengeInfo.ChallengeCancelEnum	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
static class	ChallengeInfo.FlowEnum	The flow used in the challenge.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_CHALLENGE_CANCEL
static String	JSON_PROPERTY_FLOW
static String	JSON_PROPERTY_LAST_INTERACTION
static String	JSON_PROPERTY_PHONE_NUMBER
static String	JSON_PROPERTY_RESENDS
static String	JSON_PROPERTY_RETRIES

Constructor Summary

Constructors

Constructor	Description
ChallengeInfo()

Method Summary

Modifier and Type	Method	Description
ChallengeInfo	challengeCancel(ChallengeInfo.ChallengeCancelEnum challengeCancel)	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
boolean	equals(Object o)	Return true if this ChallengeInfo object is equal to o.
ChallengeInfo	flow(ChallengeInfo.FlowEnum flow)	The flow used in the challenge.
static ChallengeInfo	fromJson(String jsonString)	Create an instance of ChallengeInfo given an JSON string
ChallengeInfo.ChallengeCancelEnum	getChallengeCancel()	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
ChallengeInfo.FlowEnum	getFlow()	The flow used in the challenge.
OffsetDateTime	getLastInteraction()	The last time of interaction with the challenge.
String	getPhoneNumber()	The last four digits of the phone number used in the challenge.
Integer	getResends()	The number of times the one-time password (OTP) was resent during the challenge.
Integer	getRetries()	The number of retries used in the challenge.
int	hashCode()
ChallengeInfo	lastInteraction(OffsetDateTime lastInteraction)	The last time of interaction with the challenge.
ChallengeInfo	phoneNumber(String phoneNumber)	The last four digits of the phone number used in the challenge.
ChallengeInfo	resends(Integer resends)	The number of times the one-time password (OTP) was resent during the challenge.
ChallengeInfo	retries(Integer retries)	The number of retries used in the challenge.
void	setChallengeCancel(ChallengeInfo.ChallengeCancelEnum challengeCancel)	Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.
void	setFlow(ChallengeInfo.FlowEnum flow)	The flow used in the challenge.
void	setLastInteraction(OffsetDateTime lastInteraction)	The last time of interaction with the challenge.
void	setPhoneNumber(String phoneNumber)	The last four digits of the phone number used in the challenge.
void	setResends(Integer resends)	The number of times the one-time password (OTP) was resent during the challenge.
void	setRetries(Integer retries)	The number of retries used in the challenge.
String	toJson()	Convert an instance of ChallengeInfo to an JSON string
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_CHALLENGE_CANCEL

public static final String JSON_PROPERTY_CHALLENGE_CANCEL

See Also:

Constant Field Values

JSON_PROPERTY_FLOW

public static final String JSON_PROPERTY_FLOW

See Also:

Constant Field Values

JSON_PROPERTY_LAST_INTERACTION

public static final String JSON_PROPERTY_LAST_INTERACTION

See Also:

Constant Field Values

JSON_PROPERTY_PHONE_NUMBER

public static final String JSON_PROPERTY_PHONE_NUMBER

See Also:

Constant Field Values

JSON_PROPERTY_RESENDS

public static final String JSON_PROPERTY_RESENDS

See Also:

Constant Field Values

JSON_PROPERTY_RETRIES

public static final String JSON_PROPERTY_RETRIES

See Also:

Constant Field Values

Constructor Detail

ChallengeInfo

public ChallengeInfo()

Method Detail

challengeCancel

public ChallengeInfo challengeCancel(ChallengeInfo.ChallengeCancelEnum challengeCancel)

Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. Possible values: * **00**: Data element is absent or value has been sent back with the key `challengeCancel`. * **01**: Cardholder selected **Cancel**. * **02**: 3DS Requestor cancelled Authentication. * **03**: Transaction abandoned. * **04**: Transaction timed out at ACS — other timeouts. * **05**: Transaction timed out at ACS — first CReq not received by ACS. * **06**: Transaction error. * **07**: Unknown. * **08**: Transaction time out at SDK.

Parameters:

challengeCancel - Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. Possible values: * **00**: Data element is absent or value has been sent back with the key `challengeCancel`. * **01**: Cardholder selected **Cancel**. * **02**: 3DS Requestor cancelled Authentication. * **03**: Transaction abandoned. * **04**: Transaction timed out at ACS — other timeouts. * **05**: Transaction timed out at ACS — first CReq not received by ACS. * **06**: Transaction error. * **07**: Unknown. * **08**: Transaction time out at SDK.

Returns:

the current ChallengeInfo instance, allowing for method chaining

getChallengeCancel

public ChallengeInfo.ChallengeCancelEnum getChallengeCancel()

Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. Possible values: * **00**: Data element is absent or value has been sent back with the key `challengeCancel`. * **01**: Cardholder selected **Cancel**. * **02**: 3DS Requestor cancelled Authentication. * **03**: Transaction abandoned. * **04**: Transaction timed out at ACS — other timeouts. * **05**: Transaction timed out at ACS — first CReq not received by ACS. * **06**: Transaction error. * **07**: Unknown. * **08**: Transaction time out at SDK.

Returns:

challengeCancel Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. Possible values: * **00**: Data element is absent or value has been sent back with the key `challengeCancel`. * **01**: Cardholder selected **Cancel**. * **02**: 3DS Requestor cancelled Authentication. * **03**: Transaction abandoned. * **04**: Transaction timed out at ACS — other timeouts. * **05**: Transaction timed out at ACS — first CReq not received by ACS. * **06**: Transaction error. * **07**: Unknown. * **08**: Transaction time out at SDK.

setChallengeCancel

public void setChallengeCancel(ChallengeInfo.ChallengeCancelEnum challengeCancel)

Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. Possible values: * **00**: Data element is absent or value has been sent back with the key `challengeCancel`. * **01**: Cardholder selected **Cancel**. * **02**: 3DS Requestor cancelled Authentication. * **03**: Transaction abandoned. * **04**: Transaction timed out at ACS — other timeouts. * **05**: Transaction timed out at ACS — first CReq not received by ACS. * **06**: Transaction error. * **07**: Unknown. * **08**: Transaction time out at SDK.

Parameters:

challengeCancel - Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. Possible values: * **00**: Data element is absent or value has been sent back with the key `challengeCancel`. * **01**: Cardholder selected **Cancel**. * **02**: 3DS Requestor cancelled Authentication. * **03**: Transaction abandoned. * **04**: Transaction timed out at ACS — other timeouts. * **05**: Transaction timed out at ACS — first CReq not received by ACS. * **06**: Transaction error. * **07**: Unknown. * **08**: Transaction time out at SDK.

flow

public ChallengeInfo flow(ChallengeInfo.FlowEnum flow)

The flow used in the challenge. Possible values: * **PWD_OTP_PHONE_FL**: one-time password (OTP) flow via SMS * **PWD_OTP_EMAIL_FL**: one-time password (OTP) flow via email * **OOB_TRIGGER_FL**: out-of-band (OOB) flow

Parameters:

flow - The flow used in the challenge. Possible values: * **PWD_OTP_PHONE_FL**: one-time password (OTP) flow via SMS * **PWD_OTP_EMAIL_FL**: one-time password (OTP) flow via email * **OOB_TRIGGER_FL**: out-of-band (OOB) flow

Returns:

the current ChallengeInfo instance, allowing for method chaining

getFlow

public ChallengeInfo.FlowEnum getFlow()

The flow used in the challenge. Possible values: * **PWD_OTP_PHONE_FL**: one-time password (OTP) flow via SMS * **PWD_OTP_EMAIL_FL**: one-time password (OTP) flow via email * **OOB_TRIGGER_FL**: out-of-band (OOB) flow

Returns:

flow The flow used in the challenge. Possible values: * **PWD_OTP_PHONE_FL**: one-time password (OTP) flow via SMS * **PWD_OTP_EMAIL_FL**: one-time password (OTP) flow via email * **OOB_TRIGGER_FL**: out-of-band (OOB) flow

setFlow

public void setFlow(ChallengeInfo.FlowEnum flow)

The flow used in the challenge. Possible values: * **PWD_OTP_PHONE_FL**: one-time password (OTP) flow via SMS * **PWD_OTP_EMAIL_FL**: one-time password (OTP) flow via email * **OOB_TRIGGER_FL**: out-of-band (OOB) flow

Parameters:

flow - The flow used in the challenge. Possible values: * **PWD_OTP_PHONE_FL**: one-time password (OTP) flow via SMS * **PWD_OTP_EMAIL_FL**: one-time password (OTP) flow via email * **OOB_TRIGGER_FL**: out-of-band (OOB) flow

lastInteraction

public ChallengeInfo lastInteraction(OffsetDateTime lastInteraction)

The last time of interaction with the challenge.

Parameters:

lastInteraction - The last time of interaction with the challenge.

Returns:

the current ChallengeInfo instance, allowing for method chaining

getLastInteraction

public OffsetDateTime getLastInteraction()

The last time of interaction with the challenge.

Returns:

lastInteraction The last time of interaction with the challenge.

setLastInteraction

public void setLastInteraction(OffsetDateTime lastInteraction)

The last time of interaction with the challenge.

Parameters:

lastInteraction - The last time of interaction with the challenge.

phoneNumber

public ChallengeInfo phoneNumber(String phoneNumber)

The last four digits of the phone number used in the challenge.

Parameters:

phoneNumber - The last four digits of the phone number used in the challenge.

Returns:

the current ChallengeInfo instance, allowing for method chaining

getPhoneNumber

public String getPhoneNumber()

The last four digits of the phone number used in the challenge.

Returns:

phoneNumber The last four digits of the phone number used in the challenge.

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

The last four digits of the phone number used in the challenge.

Parameters:

phoneNumber - The last four digits of the phone number used in the challenge.

resends

public ChallengeInfo resends(Integer resends)

The number of times the one-time password (OTP) was resent during the challenge.

Parameters:

resends - The number of times the one-time password (OTP) was resent during the challenge.

Returns:

the current ChallengeInfo instance, allowing for method chaining

getResends

public Integer getResends()

The number of times the one-time password (OTP) was resent during the challenge.

Returns:

resends The number of times the one-time password (OTP) was resent during the challenge.

setResends

public void setResends(Integer resends)

The number of times the one-time password (OTP) was resent during the challenge.

Parameters:

resends - The number of times the one-time password (OTP) was resent during the challenge.

retries

public ChallengeInfo retries(Integer retries)

The number of retries used in the challenge.

Parameters:

retries - The number of retries used in the challenge.

Returns:

the current ChallengeInfo instance, allowing for method chaining

getRetries

public Integer getRetries()

The number of retries used in the challenge.

Returns:

retries The number of retries used in the challenge.

setRetries

public void setRetries(Integer retries)

The number of retries used in the challenge.

Parameters:

retries - The number of retries used in the challenge.

equals

public boolean equals(Object o)

Return true if this ChallengeInfo object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromJson

public static ChallengeInfo fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException

Create an instance of ChallengeInfo given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ChallengeInfo

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ChallengeInfo

toJson

public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Convert an instance of ChallengeInfo to an JSON string

Returns:

JSON string

Throws:

com.fasterxml.jackson.core.JsonProcessingException