BTDropInRequest
Objective-C
@interface BTDropInRequest : NSObject <NSCopying>
/// Optional: Specify the options for the PayPal flow. If not present, a default vault flow will be used.
///
/// Note: The checkout flow is used when an amount is set on the `payPalRequest`.
@property (nonatomic, strong, nullable) BTPayPalRequest *payPalRequest;
/// 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;
/// Optional: If true and an amount is set, ThreeDSecure will be used to verify new cards. ThreeDSecure must be enabled in the control panel.
/// Defaults to false.
@property (nonatomic, assign) BOOL threeDSecureVerification;
/// Optional: Enable 3DS verification and specify options and additional information. If no amount is set, the `BTDropInRequest` `amount` will be used.
///
/// 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: Whether or not to vault the Venmo payment method upon tokenization, must be set to `false` when using a client token without a `customerId`.
/// Defaults to true
@property (nonatomic, assign) BOOL vaultVenmo;
@end
Swift
class BTDropInRequest : NSObject, NSCopying
Undocumented
-
Optional: Specify the options for the PayPal flow. If not present, a default vault flow will be used.
Note: The checkout flow is used when an amount is set on the
payPalRequest
.Declaration
Objective-C
@property (nonatomic, strong, nullable) BTPayPalRequest *payPalRequest;
Swift
var payPalRequest: BTPayPalRequest? { get set }
-
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 }
-
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 }
-
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 }
-
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 }
-
Optional: If true and an amount is set, ThreeDSecure will be used to verify new cards. ThreeDSecure must be enabled in the control panel. Defaults to false.
Declaration
Objective-C
@property (nonatomic) BOOL threeDSecureVerification;
Swift
var threeDSecureVerification: Bool { get set }
-
Optional: Enable 3DS verification and specify options and additional information. If no amount is set, the
BTDropInRequest
amount
will be used.Note: To encourage 3DS 2.0 flows, set
billingAddress
,amount
,email
,mobilePhone
for best results.Declaration
Objective-C
@property (nonatomic, strong, nullable) BTThreeDSecureRequest *threeDSecureRequest;
Swift
var threeDSecureRequest: BTThreeDSecureRequest? { get set }
-
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 }
-
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 }
-
Optional: If true, enables the managment UI. Defaults to false.
Declaration
Objective-C
@property (nonatomic) BOOL vaultManager;
Swift
var vaultManager: Bool { get set }
-
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
withallowVaultCardOverride
set tofalse
, then cards will not be vaulted. Defaults to trueDeclaration
Objective-C
@property (nonatomic) BOOL vaultCard;
Swift
var vaultCard: Bool { get set }
-
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 }
-
Optional: Whether or not to vault the Venmo payment method upon tokenization, must be set to
false
when using a client token without acustomerId
. Defaults to trueDeclaration
Objective-C
@property (nonatomic) BOOL vaultVenmo;
Swift
var vaultVenmo: Bool { get set }