DropInRequest (Drop-In API)

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

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<DropInRequest>`	`CREATOR`
`static java.lang.String`	`EXTRA_CHECKOUT_REQUEST`

Constructor Summary

Constructors
Modifier Constructor and Description

DropInRequest()

protected DropInRequest(android.os.Parcel in)

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DropInRequest`	`allowVaultCardOverride(boolean customerCheckBoxEnabled)`
`DropInRequest`	`amount(java.lang.String amount)` Deprecated.
`DropInRequest`	`cardholderNameStatus(int fieldStatus)` Sets the Cardholder Name field status, which is how it will behave in `CardForm`.
`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`	`disableCard()` Disables Card in Drop-in.
`DropInRequest`	`disableGooglePayment()` Disables Google Payment in Drop-in.
`DropInRequest`	`disablePayPal()` Disables PayPal in Drop-in.
`DropInRequest`	`disableVenmo()` Disables Venmo in Drop-in.
`java.lang.String`	`getAuthorization()`
`int`	`getCardholderNameStatus()`
`boolean`	`getDefaultVaultSetting()`
`GooglePaymentRequest`	`getGooglePaymentRequest()`
`android.content.Intent`	`getIntent(android.content.Context context)` Get an `Intent` that can be used in `androidx.appcompat.app.AppCompatActivity#startActivityForResult(Intent, int)` to launch `DropInActivity` and the Drop-in UI.
`PayPalRequest`	`getPayPalRequest()`
`ThreeDSecureRequest`	`getThreeDSecureRequest()`
`DropInRequest`	`googlePaymentRequest(GooglePaymentRequest request)` This method is optional.
`boolean`	`isCardEnabled()`
`boolean`	`isGooglePaymentEnabled()`
`boolean`	`isPayPalEnabled()`
`boolean`	`isSaveCardCheckBoxShown()`
`boolean`	`isVenmoEnabled()`
`DropInRequest`	`maskCardNumber(boolean maskCardNumber)`
`DropInRequest`	`maskSecurityCode(boolean maskSecurityCode)`
`DropInRequest`	`paypalRequest(PayPalRequest request)` This method is optional.
`DropInRequest`	`requestThreeDSecureVerification(boolean requestThreeDSecure)` If 3D Secure has been enabled in the control panel and an amount is specified in `amount(String)` or a `ThreeDSecureRequest` is provided, Drop-In will request a 3D Secure verification for any new cards added by the user.
`DropInRequest`	`threeDSecureRequest(ThreeDSecureRequest threeDSecureRequest)` This method is optional.
`DropInRequest`	`tokenizationKey(java.lang.String tokenizationKey)` Provide authorization allowing this client to communicate with Braintree.
`DropInRequest`	`vaultCard(boolean defaultValue)`
`DropInRequest`	`vaultManager(boolean vaultManager)`
`DropInRequest`	`vaultVenmo(boolean defaultValue)`
`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
```
@Deprecated
public DropInRequest amount(java.lang.String amount)
```
    Deprecated.
    
    Deprecated. Use ThreeDSecureRequest#amount(String) This method is optional. Amount is only used for 3D Secure verifications. This value must be a non-negative number and must match the currency format of the merchant account. It can only contain numbers and optionally one decimal point with exactly 2 decimal place precision (e.g., x.xx).
    
    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
  - googlePaymentRequest
```
public DropInRequest googlePaymentRequest(GooglePaymentRequest request)
```
    This method is optional.
    
    Parameters:
    
    request - The Google Payment Request GooglePaymentRequest for the transaction.
  - paypalRequest
```
public DropInRequest paypalRequest(PayPalRequest request)
```
    This method is optional.
    
    Parameters:
    
    request - The PayPal Request PayPalRequest for the transaction. If no amount is set, PayPal will default to the billing agreement (Vault) flow. If amount is set, PayPal will follow the one time payment (Checkout) flow.
  - disableGooglePayment
```
public DropInRequest disableGooglePayment()
```
    Disables Google Payment in Drop-in.
  - disablePayPal
```
public DropInRequest disablePayPal()
```
    Disables PayPal in Drop-in.
  - disableVenmo
```
public DropInRequest disableVenmo()
```
    Disables Venmo in Drop-in.
  - disableCard
```
public DropInRequest disableCard()
```
    Disables Card 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) or a ThreeDSecureRequest is provided, 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.
  - threeDSecureRequest
```
public DropInRequest threeDSecureRequest(ThreeDSecureRequest threeDSecureRequest)
```
    This method is optional.
    
    Parameters:
    
    threeDSecureRequest - ThreeDSecureRequest to specify options and additional information for 3D Secure. To encourage 3DS 2.0 flows, set ThreeDSecureRequest#billingAddress(ThreeDSecurePostalAddress), ThreeDSecureRequest#email(String), and ThreeDSecureRequest#mobilePhoneNumber(String) for best results. If no amount is set, the amount(String) will be used.
  - maskCardNumber
```
public DropInRequest maskCardNumber(boolean maskCardNumber)
```
    Parameters:
    
    maskCardNumber - true to mask the card number when the field is not focused. See com.braintreepayments.cardform.view.CardEditText for more details. Defaults to false.
  - maskSecurityCode
```
public DropInRequest maskSecurityCode(boolean maskSecurityCode)
```
    Parameters:
    
    maskSecurityCode - true to mask the security code during input. Defaults to false.
  - vaultManager
```
public DropInRequest vaultManager(boolean vaultManager)
```
    Parameters:
    
    vaultManager - true to allow customers to manage their vaulted payment methods. Defaults to false.
  - vaultCard
```
public DropInRequest vaultCard(boolean defaultValue)
```
    Parameters:
    
    defaultValue - the default value used to determine if Drop-in should vault the customer's card. This setting can be overwritten by the customer if the save card checkbox is visible using allowVaultCardOverride(boolean) If the save card CheckBox is shown, and default vault value is true: the save card CheckBox will appear pre-checked. If the save card CheckBox is shown, and default vault value is false: the save card Checkbox will appear un-checked. If the save card CheckBox is not shown, and default vault value is true: card always vaults. If the save card CheckBox is not shown, and default vault value is false: card never vaults. This value is true by default.
  - vaultVenmo
```
public DropInRequest vaultVenmo(boolean defaultValue)
```
    Parameters:
    
    defaultValue - the default value used to determine if Drop-in should vault the customer's venmo payment method. Must be set to `false` when using a client token without a `customerId`. This value is false by default.
  - allowVaultCardOverride
```
public DropInRequest allowVaultCardOverride(boolean customerCheckBoxEnabled)
```
    Parameters:
    
    customerCheckBoxEnabled - true shows save card CheckBox to allow user to choose whether or not to vault their card. false does not show Save Card CheckBox.
  - cardholderNameStatus
```
public DropInRequest cardholderNameStatus(int fieldStatus)
```
    Sets the Cardholder Name field status, which is how it will behave in CardForm. Default is CardForm#FIELD_DISABLED. Can be CardForm#FIELD_DISABLED, CardForm#FIELD_OPTIONAL, or CardForm#FIELD_REQUIRED.
  - getIntent
```
public android.content.Intent getIntent(android.content.Context context)
```
    Get an Intent that can be used in androidx.appcompat.app.AppCompatActivity#startActivityForResult(Intent, int) to launch DropInActivity and the Drop-in UI.
    
    Parameters:
    
    context -
    
    Returns:
    
    Intent containing all of the options set in DropInRequest.
  - getAuthorization
```
public java.lang.String getAuthorization()
```
  - isPayPalEnabled
```
public boolean isPayPalEnabled()
```
  - getPayPalRequest
```
public PayPalRequest getPayPalRequest()
```
  - isVenmoEnabled
```
public boolean isVenmoEnabled()
```
  - isCardEnabled
```
public boolean isCardEnabled()
```
  - getGooglePaymentRequest
```
public GooglePaymentRequest getGooglePaymentRequest()
```
  - isGooglePaymentEnabled
```
public boolean isGooglePaymentEnabled()
```
  - getThreeDSecureRequest
```
public ThreeDSecureRequest getThreeDSecureRequest()
```
  - getCardholderNameStatus
```
public int getCardholderNameStatus()
```
  - getDefaultVaultSetting
```
public boolean getDefaultVaultSetting()
```
  - isSaveCardCheckBoxShown
```
public boolean isSaveCardCheckBoxShown()
```
  - 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

Class DropInRequest

Nested Class Summary

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

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTRA_CHECKOUT_REQUEST

CREATOR

Constructor Detail

DropInRequest

DropInRequest

Method Detail

clientToken

tokenizationKey

amount

collectDeviceData

googlePaymentRequest

paypalRequest

disableGooglePayment

disablePayPal

disableVenmo

disableCard

requestThreeDSecureVerification

threeDSecureRequest

maskCardNumber

maskSecurityCode

vaultManager

vaultCard

vaultVenmo

allowVaultCardOverride

cardholderNameStatus

getIntent

getAuthorization

isPayPalEnabled

getPayPalRequest

isVenmoEnabled

isCardEnabled

getGooglePaymentRequest

isGooglePaymentEnabled

getThreeDSecureRequest

getCardholderNameStatus

getDefaultVaultSetting

isSaveCardCheckBoxShown

describeContents

writeToParcel