BTDropInRequest

Objective-C

@interface BTDropInRequest : NSObject <NSCopying>

/// Optional: Specify the options for the PayPal flow using either BTPayPalCheckoutRequest or BTPayPalVaultRequest. If not present, a default vault flow will be used.
@property (nonatomic, strong, nullable) BTPayPalRequest *payPalRequest;

/// Optional: Specify the options for the Venmo flow. If not present, a default vault flow will be used.
@property (nonatomic, strong, nullable) BTVenmoRequest *venmoRequest;

/// Optional: 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.
@property (nonatomic, assign) BOOL applePayDisabled;

/// Defaults to false. Set to true to hide the PayPal option even if enabled for your account.
@property (nonatomic, assign) BOOL paypalDisabled;

/// Defaults to false. Set to true to hide the Venmo option even if enabled for your account.
@property (nonatomic, assign) BOOL venmoDisabled;

/// Defaults to false. Set to true to hide the Card option even if enabled for your account.
@property (nonatomic, assign) BOOL cardDisabled;

/// Defaults to false. Set to true to hide all card logos for your account.
@property (nonatomic, assign) BOOL cardLogosDisabled;

/// Optional: Enable 3DS verification and specify options and additional information.
///
/// Note: To encourage 3DS 2.0 flows, set `billingAddress`, `amount`, `email`, `mobilePhone` for best results.
@property (nonatomic, strong, nullable) BTThreeDSecureRequest *threeDSecureRequest;

/// Optional: Determines the visibility and input requirements of the cardholder name field.
///
/// When set to BTFormFieldDisabled, the cardholder name field will not be displayed.
/// When set to BTFormFieldOptional, the cardholder name field will be displayed but not required.
/// When set to BTFormFieldRequired, the cardholder name field will be displayed and required.
///
/// Defaults to BTFormFieldDisabled.
@property (nonatomic, assign) BTFormFieldSetting cardholderNameSetting;

/// Optional: If true the security code will be masked.
/// Defaults to false.
@property (nonatomic, assign) BOOL shouldMaskSecurityCode;

/// Optional: If true, enables the managment UI.
/// Defaults to false.
@property (nonatomic, assign) BOOL vaultManager;

/// Optional: 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
@property (nonatomic, assign) BOOL vaultCard;

/// Optional: When true, the card form will include an option to let the customer decide not to vault the card.
/// Defaults to false
@property (nonatomic, assign) BOOL allowVaultCardOverride;

/// Optional: Customization options for Braintree Drop-in's user interface.
@property (nonatomic, strong, nullable) BTDropInUICustomization *uiCustomization;

@end

Swift

class BTDropInRequest : NSObject, NSCopying

Undocumented

Show on GitHub

  • Optional: Specify the options for the PayPal flow using either BTPayPalCheckoutRequest or BTPayPalVaultRequest. If not present, a default vault flow will be used.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) BTPayPalRequest *payPalRequest
    Show on GitHub

  • Optional: Specify the options for the Venmo flow. If not present, a default vault flow will be used.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) BTVenmoRequest *venmoRequest
    Show on GitHub

  • Optional: 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.

    Declaration

    Objective-C

    @property (nonatomic) BOOL applePayDisabled;

    Swift

    var applePayDisabled: Bool { get set }
    Show on GitHub

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL paypalDisabled;

    Swift

    var paypalDisabled: Bool { get set }
    Show on GitHub

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL venmoDisabled;

    Swift

    var venmoDisabled: Bool { get set }
    Show on GitHub

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL cardDisabled;

    Swift

    var cardDisabled: Bool { get set }
    Show on GitHub

  • Defaults to false. Set to true to hide all card logos for your account.

    Declaration

    Objective-C

    @property (nonatomic) BOOL cardLogosDisabled;

    Swift

    var cardLogosDisabled: Bool { get set }
    Show on GitHub

  • Optional: Enable 3DS verification and specify options and additional information.

    Note: To encourage 3DS 2.0 flows, set billingAddress, amount, email, mobilePhone for best results.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) BTThreeDSecureRequest *threeDSecureRequest
    Show on GitHub

  • Optional: Determines the visibility and input requirements of the cardholder name field.

    When set to BTFormFieldDisabled, the cardholder name field will not be displayed. When set to BTFormFieldOptional, the cardholder name field will be displayed but not required. When set to BTFormFieldRequired, the cardholder name field will be displayed and required.

    Defaults to BTFormFieldDisabled.

    Declaration

    Objective-C

    @property (nonatomic) BTFormFieldSetting cardholderNameSetting;

    Swift

    var cardholderNameSetting: BTFormFieldSetting { get set }
    Show on GitHub

  • Optional: If true the security code will be masked. Defaults to false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldMaskSecurityCode;

    Swift

    var shouldMaskSecurityCode: Bool { get set }
    Show on GitHub

  • Optional: If true, enables the managment UI. Defaults to false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL vaultManager;

    Swift

    var vaultManager: Bool { get set }
    Show on GitHub

  • Optional: 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

    Declaration

    Objective-C

    @property (nonatomic) BOOL vaultCard;

    Swift

    var vaultCard: Bool { get set }
    Show on GitHub

  • Optional: When true, the card form will include an option to let the customer decide not to vault the card. Defaults to false

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowVaultCardOverride;

    Swift

    var allowVaultCardOverride: Bool { get set }
    Show on GitHub

  • Optional: Customization options for Braintree Drop-in’s user interface.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) BTDropInUICustomization *uiCustomization;

    Swift

    var uiCustomization: BTDropInUICustomization? { get set }
    Show on GitHub