com.braintreepayments.api

Class PaymentRequest

java.lang.Object

com.braintreepayments.api.PaymentRequest

All Implemented Interfaces:

android.os.Parcelable

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

Used to start BraintreePaymentActivity and PaymentButton 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<PaymentRequest>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PaymentRequest	actionBarLogo(int drawable) This method is optional.
PaymentRequest	actionBarTitle(java.lang.String title) This method is optional.
PaymentRequest	amount(java.lang.String amount) This method is optional.
PaymentRequest	androidPayAllowedCountriesForShipping(java.lang.String... countryCodes) This method is optional.
PaymentRequest	androidPayCart(Cart cart) This method is optional.
PaymentRequest	androidPayPhoneNumberRequired(boolean phoneNumberRequired) This method is optional.
PaymentRequest	androidPayRequestCode(int requestCode) This method is optional.
PaymentRequest	androidPayShippingAddressRequired(boolean shippingAddressRequired) This method is optional.
PaymentRequest	clientToken(java.lang.String clientToken) Provide authorization allowing this client to communicate with Braintree.
PaymentRequest	collectDeviceData(boolean collectDeviceData) This method is optional.
PaymentRequest	currencyCode(java.lang.String currencyCode) This method is currently unused.
PaymentRequest	defaultFirst(boolean defaultFirst) This method is optional
int	describeContents()
PaymentRequest	disableAndroidPay() Disables Android Pay in the PaymentButton or Drop-in.
PaymentRequest	disablePayPal() Disables PayPal in the PaymentButton or Drop-in.
PaymentRequest	disableVenmo() Disables Venmo in the PaymentButton or Drop-in.
android.content.Intent	getIntent(android.content.Context context) Get an Intent that can be used in Activity.startActivityForResult(Intent, int) to launch BraintreePaymentActivity and the Drop-in UI.
PaymentRequest	paypalAdditionalScopes(java.util.List<java.lang.String> additionalScopes) Set additional scopes to request when a user is authorizing PayPal.
PaymentRequest	primaryDescription(java.lang.String primaryDescription) This method is optional.
PaymentRequest	secondaryDescription(java.lang.String secondaryDescription) This method is optional.
PaymentRequest	submitButtonText(java.lang.String submitButtonText) This method is optional.
PaymentRequest	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

CREATOR

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

Constructor Detail

PaymentRequest

public PaymentRequest()

PaymentRequest

protected PaymentRequest(android.os.Parcel in)

Method Detail

clientToken

public PaymentRequest 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 PaymentRequest 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 PaymentRequest amount(java.lang.String amount)

This method is optional.

Parameters:

amount - Amount of the transaction.

currencyCode

public PaymentRequest currencyCode(java.lang.String currencyCode)

This method is currently unused.

collectDeviceData

public PaymentRequest 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 PaymentRequest androidPayCart(Cart cart)

This method is optional.

Parameters:

cart - The Android Pay Cart for the transaction.

androidPayShippingAddressRequired

public PaymentRequest androidPayShippingAddressRequired(boolean shippingAddressRequired)

This method is optional.

Parameters:

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

androidPayPhoneNumberRequired

public PaymentRequest androidPayPhoneNumberRequired(boolean phoneNumberRequired)

This method is optional.

Parameters:

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

androidPayRequestCode

public PaymentRequest androidPayRequestCode(int requestCode)

This method is optional.

Parameters:

requestCode - The requestCode to use when making an Android Pay com.google.android.gms.wallet.MaskedWalletRequest with Activity.startActivityForResult(Intent, int)}.

androidPayAllowedCountriesForShipping

public PaymentRequest 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 PaymentRequest disableAndroidPay()

Disables Android Pay in the PaymentButton or Drop-in.

paypalAdditionalScopes

public PaymentRequest 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 PaymentRequest disablePayPal()

Disables PayPal in the PaymentButton or Drop-in.

disableVenmo

public PaymentRequest disableVenmo()

Disables Venmo in the PaymentButton or Drop-in.

actionBarTitle

public PaymentRequest actionBarTitle(java.lang.String title)

This method is optional.

Parameters:

title - The title to display in the action bar when present.

actionBarLogo

public PaymentRequest actionBarLogo(int drawable)

This method is optional.

Parameters:

drawable - The icon to display in the action bar when present.

primaryDescription

public PaymentRequest primaryDescription(java.lang.String primaryDescription)

This method is optional.

Parameters:

primaryDescription - Main header for description bar. Displayed in bold.

secondaryDescription

public PaymentRequest secondaryDescription(java.lang.String secondaryDescription)

This method is optional.

Parameters:

secondaryDescription - Subheader for description bar. Displayed in normal weight text.

submitButtonText

public PaymentRequest submitButtonText(java.lang.String submitButtonText)

This method is optional.

Parameters:

submitButtonText - Text for submit button. Displayed in uppercase. Will be combined with amount if set via amount(String).

defaultFirst

public PaymentRequest defaultFirst(boolean defaultFirst)

This method is optional

Parameters:

defaultFirst - When true, payment methods will be displayed with the current customer's default payment method first, followed the remaining payment methods, sorted by most recent usage.

getIntent

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

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

Parameters:

context -

Returns:

Intent containing all of the options set in PaymentRequest.

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