com.braintreepayments.api.dropin

Class DropInRequest

java.lang.Object

com.braintreepayments.api.dropin.DropInRequest

All Implemented Interfaces:

android.os.Parcelable

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

Used to start DropInActivity with specified options.

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<DropInRequest>	CREATOR
static java.lang.String	EXTRA_CHECKOUT_REQUEST

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	DropInRequest()
protected	DropInRequest(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
DropInRequest	amount(java.lang.String amount) This method is optional.
DropInRequest	androidPayAllowedCountriesForShipping(java.lang.String... countryCodes) This method is optional.
DropInRequest	androidPayCart(Cart cart) This method is optional.
DropInRequest	androidPayPhoneNumberRequired(boolean phoneNumberRequired) This method is optional.
DropInRequest	androidPayShippingAddressRequired(boolean shippingAddressRequired) This method is optional.
DropInRequest	clientToken(java.lang.String clientToken) Provide authorization allowing this client to communicate with Braintree.
DropInRequest	collectDeviceData(boolean collectDeviceData) This method is optional.
int	describeContents()
DropInRequest	disableAndroidPay() Disables Android Pay in Drop-in.
DropInRequest	disablePayPal() Disables PayPal in Drop-in.
DropInRequest	disableVenmo() Disables Venmo in Drop-in.
android.content.Intent	getIntent(android.content.Context context) Get an Intent that can be used in Activity.startActivityForResult(Intent, int) to launch DropInActivity and the Drop-in UI.
DropInRequest	paypalAdditionalScopes(java.util.List<java.lang.String> additionalScopes) Set additional scopes to request when a user is authorizing PayPal.
DropInRequest	requestThreeDSecureVerification(boolean requestThreeDSecure) If 3D Secure has been enabled in the control panel and an amount is specified in amount(String), Drop-In will request a 3D Secure verification for any new cards added by the user.
DropInRequest	tokenizationKey(java.lang.String tokenizationKey) Provide authorization allowing this client to communicate with Braintree.
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

EXTRA_CHECKOUT_REQUEST

public static final java.lang.String EXTRA_CHECKOUT_REQUEST

See Also:

Constant Field Values

CREATOR

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

Constructor Detail

DropInRequest

public DropInRequest()

DropInRequest

protected DropInRequest(android.os.Parcel in)

Method Detail

clientToken

public DropInRequest clientToken(java.lang.String clientToken)

Provide authorization allowing this client to communicate with Braintree. Either clientToken(String) or tokenizationKey(String) must be set or an com.braintreepayments.api.exceptions.AuthenticationException will occur.

Parameters:

clientToken - The client token to use for the request.

tokenizationKey

public DropInRequest tokenizationKey(java.lang.String tokenizationKey)

Provide authorization allowing this client to communicate with Braintree. Either clientToken(String) or tokenizationKey(String) must be set or an com.braintreepayments.api.exceptions.AuthenticationException will occur.

Parameters:

tokenizationKey - The tokenization key to use for the request.

amount

public DropInRequest amount(java.lang.String amount)

This method is optional. Amount is only used for 3D Secure verifications.

Parameters:

amount - Amount of the transaction.

collectDeviceData

public DropInRequest collectDeviceData(boolean collectDeviceData)

This method is optional.

Parameters:

collectDeviceData - true if Drop-in should collect and return device data for fraud prevention.

See Also:

DataCollector

androidPayCart

public DropInRequest androidPayCart(Cart cart)

This method is optional.

Parameters:

cart - The Android Pay Cart for the transaction.

androidPayShippingAddressRequired

public DropInRequest androidPayShippingAddressRequired(boolean shippingAddressRequired)

This method is optional.

Parameters:

shippingAddressRequired - true if Android Pay requests should request a shipping address from the user.

androidPayPhoneNumberRequired

public DropInRequest androidPayPhoneNumberRequired(boolean phoneNumberRequired)

This method is optional.

Parameters:

phoneNumberRequired - true if Android Pay requests should request a phone number from the user.

androidPayAllowedCountriesForShipping

public DropInRequest androidPayAllowedCountriesForShipping(java.lang.String... countryCodes)

This method is optional.

Parameters:

countryCodes - countries to which shipping is supported. Follows the ISO 3166-2 format (ex: "US", "CA", "JP")

See Also:

ISO 3166 country codes

disableAndroidPay

public DropInRequest disableAndroidPay()

Disables Android Pay in Drop-in.

paypalAdditionalScopes

public DropInRequest paypalAdditionalScopes(java.util.List<java.lang.String> additionalScopes)

Set additional scopes to request when a user is authorizing PayPal. This method is optional.

Parameters:

additionalScopes - A List of additional scopes. Ex: PayPal.SCOPE_ADDRESS. Acceptable scopes are defined in PayPal.

disablePayPal

public DropInRequest disablePayPal()

Disables PayPal in Drop-in.

disableVenmo

public DropInRequest disableVenmo()

Disables Venmo in Drop-in.

requestThreeDSecureVerification

public DropInRequest requestThreeDSecureVerification(boolean requestThreeDSecure)

If 3D Secure has been enabled in the control panel and an amount is specified in amount(String), Drop-In will request a 3D Secure verification for any new cards added by the user.

Parameters:

requestThreeDSecure - true to request a 3D Secure verification as part of Drop-In, false to not request a 3D Secure verification. Defaults to false.

getIntent

public android.content.Intent getIntent(android.content.Context context)

Get an Intent that can be used in Activity.startActivityForResult(Intent, int) to launch DropInActivity and the Drop-in UI.

Parameters:

context -

Returns:

Intent containing all of the options set in DropInRequest.

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