Interface Request

A Braintree Drop-In Request

interface Request {
    allowVaultCardOverride?: boolean;
    applePayDisabled?: boolean;
    cardDisabled?: boolean;
    cardholderNameStatus?: CardFormFieldStatus;
    googlePayRequest?: CdvPurchase.Braintree.GooglePay.Request;
    maskCardNumber?: boolean;
    maskSecurityCode?: boolean;
    paypalDisabled?: boolean;
    threeDSecureRequest?: CdvPurchase.Braintree.ThreeDSecure.Request;
    vaultCard?: boolean;
    vaultCardDefaultValue?: boolean;
    vaultManager?: boolean;
}

Properties

allowVaultCardOverride? applePayDisabled? cardDisabled? cardholderNameStatus? googlePayRequest? maskCardNumber? maskSecurityCode? paypalDisabled? threeDSecureRequest? vaultCard? vaultCardDefaultValue? vaultManager?

Properties

Optional allowVaultCardOverride

allowVaultCardOverride?: boolean
  • true shows save card CheckBox to allow user to choose whether or not to vault their card.
  • false does not show Save Card CheckBox.

Default value is false.

Optional applePayDisabled

applePayDisabled?: boolean

Use this parameter to disable Apple Pay.

Otherwise if Apple Pay is correctly configured, Apple Pay will appear as a selection in the Payment Method options.

Optional cardDisabled

cardDisabled?: boolean

If set to true, disables Card in Drop-in. Default value is false.

Optional cardholderNameStatus

cardholderNameStatus?: CardFormFieldStatus

Sets the Cardholder Name field status, which is how it will behave in CardForm.

Default is DISABLED.

Optional googlePayRequest

googlePayRequest?: CdvPurchase.Braintree.GooglePay.Request

Provide the Google Pay request if you need Google Pay support

Optional maskCardNumber

maskCardNumber?: boolean

True to mask the card number when the field is not focused.

See com.braintreepayments.cardform.view.CardEditText for more details.

Android only.

Optional maskSecurityCode

maskSecurityCode?: boolean

true to mask the security code during input. Defaults to false.

Optional paypalDisabled

paypalDisabled?: boolean

Set to true to hide the PayPal option even if enabled for your account.

Defaults to false. Set to true to hide the PayPal option even if enabled for your account.

Optional threeDSecureRequest

threeDSecureRequest?: CdvPurchase.Braintree.ThreeDSecure.Request

Provide the ThreeDSecure request if you need 3DS support

Optional vaultCard

vaultCard?: boolean

Whether or not to vault the card upon tokenization.

Can only be applied when initializing the Braintree client with a client token that was generated with a customer ID.

When set to false with allowVaultCardOverride set to false, then cards will not be vaulted.

Defaults to true

Optional vaultCardDefaultValue

vaultCardDefaultValue?: boolean

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 setAllowVaultCardOverride(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.

Optional vaultManager

vaultManager?: boolean

true to allow customers to manage their vaulted payment methods.

Defaults to false.

Settings

Member Visibility

Theme

On This Page

allowVaultCardOverrideapplePayDisabledcardDisabledcardholderNameStatusgooglePayRequestmaskCardNumbermaskSecurityCodepaypalDisabledthreeDSecureRequestvaultCardvaultCardDefaultValuevaultManager