com.braintreepayments.api.models

Class ThreeDSecureRequest

java.lang.Object

com.braintreepayments.api.models.ThreeDSecureRequest

All Implemented Interfaces:

android.os.Parcelable

public class ThreeDSecureRequest
extends java.lang.Object
implements android.os.Parcelable

A class to contain 3D Secure request information used for authentication

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<ThreeDSecureRequest>	CREATOR
static java.lang.String	CREDIT
static java.lang.String	DEBIT
static java.lang.String	VERSION_1
static java.lang.String	VERSION_2

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
ThreeDSecureRequest()
ThreeDSecureRequest(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
ThreeDSecureRequest	accountType(java.lang.String accountType) Optional.
ThreeDSecureRequest	additionalInformation(ThreeDSecureAdditionalInformation additionalInformation) Optional.
ThreeDSecureRequest	amount(java.lang.String amount) Set the amount
ThreeDSecureRequest	billingAddress(ThreeDSecurePostalAddress billingAddress) Optional.
java.lang.String	build(java.lang.String dfReferenceId)
ThreeDSecureRequest	challengeRequested(boolean challengeRequested) Optional If set to true, the customer will be asked to complete the authentication challenge if possible
ThreeDSecureRequest	dataOnlyRequested(boolean dataOnlyRequested)
int	describeContents()
ThreeDSecureRequest	email(java.lang.String email) Optional.
ThreeDSecureRequest	exemptionRequested(boolean exemptionRequested) Optional If set to true, an exemption to the authentication challenge will be requested
java.lang.String	getAccountType()
ThreeDSecureAdditionalInformation	getAdditionalInformation()
java.lang.String	getAmount()
ThreeDSecurePostalAddress	getBillingAddress()
java.lang.String	getEmail()
java.lang.String	getMobilePhoneNumber()
java.lang.String	getNonce()
java.lang.String	getShippingMethod()
UiCustomization	getUiCustomization()
ThreeDSecureV1UiCustomization	getV1UiCustomization()
java.lang.String	getVersionRequested()
boolean	isChallengeRequested()
boolean	isDataOnlyRequested()
boolean	isExemptionRequested()
ThreeDSecureRequest	mobilePhoneNumber(java.lang.String mobilePhoneNumber) Optional.
ThreeDSecureRequest	nonce(java.lang.String nonce) Set the nonce
ThreeDSecureRequest	shippingMethod(java.lang.String shippingMethod) Optional.
ThreeDSecureRequest	uiCustomization(UiCustomization uiCustomization) Optional UI Customization for the 3DS2 challenge views.
ThreeDSecureRequest	v1UiCustomization(ThreeDSecureV1UiCustomization v1UiCustomization) Optional UI Customization for the 3DS1 challenge views.
ThreeDSecureRequest	versionRequested(java.lang.String versionRequested) Optional.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION_1

public static final java.lang.String VERSION_1

See Also:

Constant Field Values

VERSION_2

public static final java.lang.String VERSION_2

See Also:

Constant Field Values

CREDIT

public static final java.lang.String CREDIT

See Also:

Constant Field Values

DEBIT

public static final java.lang.String DEBIT

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<ThreeDSecureRequest> CREATOR

Constructor Detail

ThreeDSecureRequest

public ThreeDSecureRequest()

ThreeDSecureRequest

public ThreeDSecureRequest(android.os.Parcel in)

Method Detail

nonce

public ThreeDSecureRequest nonce(java.lang.String nonce)

Set the nonce

Parameters:

nonce - The nonce that represents a card to perform a 3D Secure verification against.

amount

public ThreeDSecureRequest amount(java.lang.String amount)

Set the amount

Parameters:

amount - The amount of the transaction in the current merchant account's currency. This must be expressed in numbers with an optional decimal (using `.`) and precision up to the hundredths place. For example, if you're processing a transaction for 1.234,56 € then `amount` should be `1234.56`.

mobilePhoneNumber

public ThreeDSecureRequest mobilePhoneNumber(java.lang.String mobilePhoneNumber)

Optional. Set the mobilePhoneNumber

Parameters:

mobilePhoneNumber - The mobile phone number used for verification. Only numbers. Remove dashes, parentheses and other characters.

email

public ThreeDSecureRequest email(java.lang.String email)

Optional. Set the email

Parameters:

email - The email used for verification.

shippingMethod

public ThreeDSecureRequest shippingMethod(java.lang.String shippingMethod)

Optional. Set the shippingMethod Possible Values: 01 Same Day 02 Overnight / Expedited 03 Priority (2-3 Days) 04 Ground 05 Electronic Delivery 06 Ship to Store

Parameters:

shippingMethod - The 2-digit string indicating the shipping method chosen for the transaction.

billingAddress

public ThreeDSecureRequest billingAddress(ThreeDSecurePostalAddress billingAddress)

Optional. Set the billingAddress

Parameters:

billingAddress - The billing address used for verification.

versionRequested

public ThreeDSecureRequest versionRequested(java.lang.String versionRequested)

Optional. Set the desired ThreeDSecure version. Possible Values defined at ThreeDSecureVersion.

• VERSION_2 if ThreeDSecure V2 flows are desired, when possible.
• VERSION_1 if only ThreeDSecure V1 flows are desired. Default value.

Will default to VERSION_1.

Parameters:

versionRequested - ThreeDSecureVersion The desired ThreeDSecure version.

accountType

public ThreeDSecureRequest accountType(java.lang.String accountType)

Optional. The account type selected by the cardholder. Some cards can be processed using either a credit or debit account and cardholders have the option to choose which account to use. Possible values defined at ThreeDSecureAccountType.

Parameters:

accountType - ThreeDSecureAccountType The account type selected by the cardholder.

additionalInformation

public ThreeDSecureRequest additionalInformation(ThreeDSecureAdditionalInformation additionalInformation)

Optional. The additional information used for verification

Parameters:

additionalInformation - Additional information.

challengeRequested

public ThreeDSecureRequest challengeRequested(boolean challengeRequested)

Optional If set to true, the customer will be asked to complete the authentication challenge if possible

Parameters:

challengeRequested - decides if a challenge will be forced.

dataOnlyRequested

public ThreeDSecureRequest dataOnlyRequested(boolean dataOnlyRequested)

exemptionRequested

public ThreeDSecureRequest exemptionRequested(boolean exemptionRequested)

Optional If set to true, an exemption to the authentication challenge will be requested

Parameters:

exemptionRequested - decides if a exemption will be requested.

uiCustomization

public ThreeDSecureRequest uiCustomization(UiCustomization uiCustomization)

Optional UI Customization for the 3DS2 challenge views. See UiCustomization documentation.

Parameters:

uiCustomization - specifies how 3DS2 challenge views should be customized.

v1UiCustomization

public ThreeDSecureRequest v1UiCustomization(ThreeDSecureV1UiCustomization v1UiCustomization)

Optional UI Customization for the 3DS1 challenge views.

Parameters:

v1UiCustomization - specifies how 3DS1 challenge views should be customized.

getNonce

public java.lang.String getNonce()

Returns:

The nonce to use for 3D Secure verification

getAmount

public java.lang.String getAmount()

Returns:

The amount to use for 3D Secure verification

getMobilePhoneNumber

public java.lang.String getMobilePhoneNumber()

Returns:

The mobile phone number to use for 3D Secure verification

getEmail

public java.lang.String getEmail()

Returns:

The email to use for 3D Secure verification

getShippingMethod

public java.lang.String getShippingMethod()

Returns:

The shipping method to use for 3D Secure verification

getBillingAddress

public ThreeDSecurePostalAddress getBillingAddress()

Returns:

The billing address to use for 3D Secure verification

getVersionRequested

public java.lang.String getVersionRequested()

Returns:

The requested ThreeDSecure version

getAccountType

public java.lang.String getAccountType()

Returns:

The account type

getAdditionalInformation

public ThreeDSecureAdditionalInformation getAdditionalInformation()

Returns:

The additional information used for verification ThreeDSecureAdditionalInformation is only used for VERSION_2 requests.

isChallengeRequested

public boolean isChallengeRequested()

Returns:

If a challenge has been requested

isDataOnlyRequested

public boolean isDataOnlyRequested()

isExemptionRequested

public boolean isExemptionRequested()

Returns:

If a exemption has been requested

getUiCustomization

public UiCustomization getUiCustomization()

Returns:

The UI customization for 3DS2 challenge views.

getV1UiCustomization

public ThreeDSecureV1UiCustomization getV1UiCustomization()

Returns:

The UI customization for 3DS1 challenge views.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

build

public java.lang.String build(java.lang.String dfReferenceId)

Returns:

String representation of ThreeDSecureRequest for API use.