Classes

The following classes are available globally.

BTAmericanExpressClient
BTAmericanExpressClient enables you to look up the rewards balance of American Express cards.
See more
Declaration
Objective-C

@interface BTAmericanExpressClient : NSObject
Swift

class BTAmericanExpressClient : NSObject
Show on GitHub
BTAmericanExpressRewardsBalance
Contains information about an American Express rewards balance.
See more
Declaration
Objective-C

@interface BTAmericanExpressRewardsBalance : NSObject
Swift

class BTAmericanExpressRewardsBalance : NSObject
Show on GitHub
BTApplePayCardNonce
Contains information about a tokenized Apple Pay card.
See more
Declaration
Objective-C

@interface BTApplePayCardNonce : BTPaymentMethodNonce
Swift

class BTApplePayCardNonce : BTPaymentMethodNonce
Show on GitHub
BTApplePayClient
Used to process Apple Pay payments
See more
Declaration
Objective-C

@interface BTApplePayClient : NSObject
Swift

class BTApplePayClient : NSObject
Show on GitHub
BTConfiguration
Contains information specific to a merchant’s Braintree integration
See more
Declaration
Objective-C

@interface BTConfiguration : NSObject
Swift

class BTConfiguration : NSObject
Show on GitHub
BTAuthenticationInsight
Information pertaining to the regulatory environment for a credit card if authentication insight is requested during tokenization.
See more
Declaration
Objective-C

@interface BTAuthenticationInsight : NSObject
Swift

class BTAuthenticationInsight : NSObject
Show on GitHub
BTCard
The card tokenization request represents raw credit or debit card data provided by the customer. Its main purpose is to serve as the input for tokenization.
See more
Declaration
Objective-C

@interface BTCard : NSObject
Swift

class BTCard : NSObject
Show on GitHub
BTCardClient
Used to process cards
See more
Declaration
Objective-C

@interface BTCardClient : NSObject
Swift

class BTCardClient : NSObject
Show on GitHub
BTCardNonce
Contains information about a tokenized card.
See more
Declaration
Objective-C

@interface BTCardNonce : BTPaymentMethodNonce
Swift

class BTCardNonce : BTPaymentMethodNonce
Show on GitHub
BTCardRequest
Contains information about a card to tokenize
See more
Declaration
Objective-C

@interface BTCardRequest : NSObject
Swift

class BTCardRequest : NSObject
Show on GitHub
BTThreeDSecureInfo
Contains information about the 3D Secure status of a payment method
See more
Declaration
Objective-C

@interface BTThreeDSecureInfo : NSObject
Swift

class BTThreeDSecureInfo : NSObject
Show on GitHub
BTAPIClient
This class acts as the entry point for accessing the Braintree APIs via common HTTP methods performed on API endpoints.

Note
It also manages authentication via tokenization key and provides access to a merchant’s gateway configuration.
See more
Declaration
Objective-C

@interface BTAPIClient : NSObject
Swift

class BTAPIClient : NSObject
Show on GitHub

BTAppContextSwitcher

BTAppContextSwitcher
Handles return URLs when returning from app context switch and routes the return URL to the correct app context switch driver class.

Note
returnURLScheme must contain your app’s registered URL Type that starts with the app’s bundle ID. When your app returns from app switch, the app delegate should call handleOpenURL: or handleOpenURLContext:
See more
Declaration
Objective-C

@interface BTAppContextSwitcher : NSObject
Swift

class BTAppContextSwitcher : NSObject
Show on GitHub
BTBinData
Contains the bin data associated with a payment method
See more
Declaration
Objective-C

@interface BTBinData : NSObject
Swift

class BTBinData : NSObject
Show on GitHub
BTClientMetadata
Represents the metadata associated with a session for posting along with payment data during tokenization

When a payment method is tokenized, the client api accepts parameters under _meta which are used to determine where payment data originated.

In general, this data may evolve and be used in different ways by different integrations in a single app. For example, if both Apple Pay and drop in are used. In this case, the source and integration may change over time, while the sessionID should remain constant. To achieve this, users of this class should use mutableCopy to create a new copy based on the existing session and then update the object as needed.
See more
Declaration
Objective-C

@interface BTClientMetadata : NSObject <NSCopying, NSMutableCopying>
Swift

class BTClientMetadata : NSObject, NSCopying, NSMutableCopying
Show on GitHub


                    
                    
                    BTMutableClientMetadata

Mutable BTClientMetadata

Declaration

Objective-C

@interface BTMutableClientMetadata : BTClientMetadata

Swift

class BTMutableClientMetadata : BTClientMetadata

Show on GitHub

BTClientToken
An authorization string used to initialize the Braintree SDK
See more
Declaration
Objective-C

@interface BTClientToken : NSObject <NSCoding, NSCopying>
Swift

class BTClientToken : NSObject, NSCoding, NSCopying
Show on GitHub


                    
                    
                    BTJSON

A type-safe wrapper around JSON

See

http://www.json.org/

The primary goal of this class is to two-fold: (1) prevent bugs by staying true to JSON (json.org) rather than interpreting it in mysterious ways; (2) prevent bugs by making JSON interpretation as un-surprising as possible.

Most notably, type casting occurs via the as* nullable methods; errors are deferred and can be checked explicitly using isError and asError.

Example Data:

   {
     "foo": "bar",
     "baz": [1, 2, 3]
   }

Example Usage:

   let json : BTJSON = BTJSON(data:data);
   json.isError  // false
   json.isObject // true
   json.isNumber // false
   json.asObject // self
   json["foo"]   // JSON(@"bar")
   json["foo"].isString // true
   json["foo"].asString // @"bar"
   json["baz"].asString // null
   json["baz"]["quux"].isError // true
   json["baz"]["quux"].asError // NSError(domain: BTJSONErrorDomain, code: BTJSONErrorCodeTypeInvalid)
   json["baz"][0].asError // null
   json["baz"][0].asInteger //
   json["random"]["nested"]["things"][3].isError // true

   let json : BTJSON = BTJSON() // json.asJson => {}
   json["foo"][0] = "bar" // json.asJSON => { "foo": ["bar"] }
   json["baz"] = [ 1, 2, 3 ] // json.asJSON => { "foo": ["bar"], "baz": [1,2,3] }
   json["quux"] = NSSet() // json.isError => true, json.asJSON => throws NSError(domain: BTJSONErrorDomain, code: BTJSONErrorInvalidData)

Declaration

Objective-C

@interface BTJSON : NSObject

Swift

class BTJSON : NSObject

Show on GitHub

BTLogger
Braintree leveled logger
See more
Declaration
Objective-C

@interface BTLogger : NSObject
Swift

class BTLogger : NSObject
Show on GitHub
BTPaymentMethodNonce
BTPaymentMethodNonce is for generic tokenized payment information.

For example, if a customer’s vaulted payment methods contains a type that’s not recognized or supported by the Braintree SDK or the client-side integration (e.g. the vault contains a PayPal account but the client-side integration does not include the PayPal component), this type can act as a fallback.

The payment method nonce is a public token that acts as a placeholder for sensitive payments data that has been uploaded to Braintree for subsequent processing. The nonce is safe to access on the client and can be used on your server to reference the data in Braintree operations, such as Transaction.sale.
See more
Declaration
Objective-C

@interface BTPaymentMethodNonce : NSObject
Swift

class BTPaymentMethodNonce : NSObject
Show on GitHub


                    
                    
                    BTPostalAddress

Generic postal address

Declaration

Objective-C

@interface BTPostalAddress : NSObject <NSCopying>

Swift

class BTPostalAddress : NSObject, NSCopying

Show on GitHub

BTURLUtils
A helper class for converting URL queries to and from dictionaries
See more
Declaration
Objective-C

@interface BTURLUtils : NSObject
Swift

class BTURLUtils : NSObject
Show on GitHub
BTDataCollector
Braintree’s advanced fraud protection solution
See more
Declaration
Objective-C

@interface BTDataCollector : NSObject
Swift

class BTDataCollector : NSObject
Show on GitHub
BTPayPalAccountNonce
Contains information about a PayPal payment method
See more
Declaration
Objective-C

@interface BTPayPalAccountNonce : BTPaymentMethodNonce
Swift

class BTPayPalAccountNonce : BTPaymentMethodNonce
Show on GitHub


                    
                    
                    BTPayPalCheckoutRequest

Undocumented

Declaration

Objective-C

@interface BTPayPalCheckoutRequest : BTPayPalRequest

Swift

class BTPayPalCheckoutRequest : BTPayPalRequest

Show on GitHub

BTPayPalCreditFinancing
Contains information about a PayPal credit financing option
See more
Declaration
Objective-C

@interface BTPayPalCreditFinancing : NSObject
Swift

class BTPayPalCreditFinancing : NSObject
Show on GitHub
BTPayPalCreditFinancingAmount
Contains information about a PayPal credit amount
See more
Declaration
Objective-C

@interface BTPayPalCreditFinancingAmount : NSObject
Swift

class BTPayPalCreditFinancingAmount : NSObject
Show on GitHub
BTPayPalDriver
Used to tokenize PayPal accounts.
See more
Declaration
Objective-C

@interface BTPayPalDriver : NSObject
Swift

class BTPayPalDriver : NSObject
Show on GitHub
BTPayPalLineItem
A PayPal line item to be displayed in the PayPal checkout flow.
See more
Declaration
Objective-C

@interface BTPayPalLineItem : NSObject
Swift

class BTPayPalLineItem : NSObject
Show on GitHub
BTPayPalRequest
Base options for PayPal Checkout and PayPal Vault flows.

Note
Do not instantiate this class directly. Instead, use BTPayPalCheckoutRequest or BTPayPalVaultRequest.
See more
Declaration
Objective-C

@interface BTPayPalRequest : NSObject
Swift

class BTPayPalRequest : NSObject
Show on GitHub
BTPayPalVaultRequest
Options for the PayPal Vault flow.
See more
Declaration
Objective-C

@interface BTPayPalVaultRequest : BTPayPalRequest
Swift

class BTPayPalVaultRequest : BTPayPalRequest
Show on GitHub


                    
                    
                    BTLocalPaymentRequest

Used to initialize a local payment flow

Declaration

Objective-C

@interface BTLocalPaymentRequest
    : BTPaymentFlowRequest <BTPaymentFlowRequestDelegate>

Swift

class BTLocalPaymentRequest : BTPaymentFlowRequest, BTPaymentFlowRequestDelegate

Show on GitHub


                    
                    
                    BTLocalPaymentResult

The result of an local payment flow

Declaration

Objective-C

@interface BTLocalPaymentResult : BTPaymentFlowResult

Swift

class BTLocalPaymentResult : BTPaymentFlowResult

Show on GitHub

BTPaymentFlowDriver
BTPaymentFlowDriver handles the shared aspects of web/app payment flows.

Handles the app switching and shared logic for payment flows that use web or app switching.
See more
Declaration
Objective-C

@interface BTPaymentFlowDriver : NSObject <BTAppContextSwitchDriver, BTPaymentFlowDriverDelegate>
Swift

class BTPaymentFlowDriver : NSObject, BTAppContextSwitchDriver, BTPaymentFlowDriverDelegate
Show on GitHub
BTPaymentFlowRequest
Wrapper for a payment flow request.
Declaration
Objective-C

@interface BTPaymentFlowRequest : NSObject
Swift

class BTPaymentFlowRequest : NSObject
Show on GitHub
BTPaymentFlowResult
Wrapper for a payment flow result.
Declaration
Objective-C

@interface BTPaymentFlowResult : NSObject
Swift

class BTPaymentFlowResult : NSObject
Show on GitHub
BTThreeDSecureAdditionalInformation
Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.
See more
Declaration
Objective-C

@interface BTThreeDSecureAdditionalInformation : NSObject
Swift

class BTThreeDSecureAdditionalInformation : NSObject
Show on GitHub
BTThreeDSecureLookup
The result of a 3DS lookup.

Contains liability shift and challenge information.
See more
Declaration
Objective-C

@interface BTThreeDSecureLookup : NSObject
Swift

class BTThreeDSecureLookup : NSObject
Show on GitHub


                    
                    
                    BTThreeDSecurePostalAddress

Postal address for 3D Secure flows

Declaration

Objective-C

@interface BTThreeDSecurePostalAddress : NSObject <NSCopying>

Swift

class BTThreeDSecurePostalAddress : NSObject, NSCopying

Show on GitHub


                    
                    
                    BTThreeDSecureRequest

Used to initialize a 3D Secure payment flow

Declaration

Objective-C

@interface BTThreeDSecureRequest
    : BTPaymentFlowRequest <BTPaymentFlowRequestDelegate>

Swift

class BTThreeDSecureRequest : BTPaymentFlowRequest, BTPaymentFlowRequestDelegate

Show on GitHub


                    
                    
                    BTThreeDSecureResult

The result of a 3D Secure payment flow

Declaration

Objective-C

@interface BTThreeDSecureResult : BTPaymentFlowResult

Swift

class BTThreeDSecureResult : BTPaymentFlowResult

Show on GitHub

BTThreeDSecureV1UICustomization
UI Customization Options for 3D Secure 1 Flows.
See more
Declaration
Objective-C

@interface BTThreeDSecureV1UICustomization : NSObject
Swift

class BTThreeDSecureV1UICustomization : NSObject
Show on GitHub
BTThreeDSecureV2BaseCustomization
Base customization options for 3D Secure 2 flows.
See more
Declaration
Objective-C

@interface BTThreeDSecureV2BaseCustomization : NSObject
Swift

class BTThreeDSecureV2BaseCustomization : NSObject
Show on GitHub


                    
                    
                    BTThreeDSecureV2ButtonCustomization

Button customization options for 3D Secure 2 flows.

Declaration

Objective-C

@interface BTThreeDSecureV2ButtonCustomization
    : BTThreeDSecureV2BaseCustomization

Swift

class BTThreeDSecureV2ButtonCustomization : BTThreeDSecureV2BaseCustomization

Show on GitHub


                    
                    
                    BTThreeDSecureV2LabelCustomization

Label customization options for 3D Secure 2 flows.

Declaration

Objective-C

@interface BTThreeDSecureV2LabelCustomization
    : BTThreeDSecureV2BaseCustomization

Swift

class BTThreeDSecureV2LabelCustomization : BTThreeDSecureV2BaseCustomization

Show on GitHub


                    
                    
                    BTThreeDSecureV2TextBoxCustomization

Text box customization options for 3D Secure 2 flows.

Declaration

Objective-C

@interface BTThreeDSecureV2TextBoxCustomization
    : BTThreeDSecureV2BaseCustomization

Swift

class BTThreeDSecureV2TextBoxCustomization : BTThreeDSecureV2BaseCustomization

Show on GitHub


                    
                    
                    BTThreeDSecureV2ToolbarCustomization

Toolbar customization options for 3D Secure 2 flows.

Declaration

Objective-C

@interface BTThreeDSecureV2ToolbarCustomization
    : BTThreeDSecureV2BaseCustomization

Swift

class BTThreeDSecureV2ToolbarCustomization : BTThreeDSecureV2BaseCustomization

Show on GitHub

BTThreeDSecureV2UICustomization
UI customization options for 3D Secure 2 flows.
See more
Declaration
Objective-C

@interface BTThreeDSecureV2UICustomization : NSObject
Swift

class BTThreeDSecureV2UICustomization : NSObject
Show on GitHub
BTCardCapabilities
Deprecated

The UnionPay SMS integration is deprecated, as UnionPay can now be processed as a credit card through their partnership with Discover. Use BTCardClient.tokenizeCard(card: completion:).

Contains information about a card’s capabilities
See more
Declaration
Objective-C

@interface BTCardCapabilities : NSObject
Swift

class BTCardCapabilities : NSObject
Show on GitHub
BTVenmoAccountNonce
Contains information about a Venmo Account payment method
See more
Declaration
Objective-C

@interface BTVenmoAccountNonce : BTPaymentMethodNonce
Swift

class BTVenmoAccountNonce : BTPaymentMethodNonce
Show on GitHub


                    
                    
                    BTVenmoDriver

Used to process Venmo payments

Declaration

Objective-C

@interface BTVenmoDriver : NSObject <BTAppContextSwitchDriver>

Swift

class BTVenmoDriver : NSObject, BTAppContextSwitchDriver

Show on GitHub

BTVenmoLineItem
A Venmo line item to be displayed in the Venmo Paysheet.
See more
Declaration
Objective-C

@interface BTVenmoLineItem : NSObject
Swift

class BTVenmoLineItem : NSObject
Show on GitHub
BTVenmoRequest
A BTVenmoRequest specifies options that contribute to the Venmo flow
See more
Declaration
Objective-C

@interface BTVenmoRequest : NSObject
Swift

class BTVenmoRequest : NSObject
Show on GitHub
PPDataCollector
Enables you to collect data about a customer’s device and correlate it with a session identifier on your server.
See more
Declaration
Swift

@objc public class PPDataCollector : NSObject
Show on GitHub
BTPayPalNativeCheckoutAccountNonce
Contains information about a PayPal payment method.
See more
Declaration
Swift

@objcMembers public class BTPayPalNativeCheckoutAccountNonce : NSObject
Show on GitHub
BTPayPalNativeCheckoutClient
Client used to collect PayPal payment methods. If possible, this client will present a native flow; otherwise, it will fall back to a web flow.
See more
Declaration
Swift

@objc public class BTPayPalNativeCheckoutClient : NSObject
Show on GitHub
BTPayPalNativeCheckoutRequest
Options for the PayPal Checkout flow.
See more
Declaration
Swift

@objcMembers public class BTPayPalNativeCheckoutRequest : BTPayPalNativeRequest
Show on GitHub


                    
                    
                    BTPayPalNativeRequest

Declaration

Swift

@objcMembers
public class BTPayPalNativeRequest : NSObject

Show on GitHub

BTPayPalNativeVaultRequest
Options for the PayPal Vault flow.
See more
Declaration
Swift

@objcMembers public class BTPayPalNativeVaultRequest : BTPayPalNativeRequest
Show on GitHub
BTSEPADirectDebitClient
Used to integrate with SEPA Direct Debit.
See more
Declaration
Swift

@objcMembers public class BTSEPADirectDebitClient : NSObject
Show on GitHub
BTSEPADirectDebitNonce
A payment method nonce representing a SEPA Direct Debit payment.
See more
Declaration
Swift

@objcMembers public class BTSEPADirectDebitNonce : NSObject
Show on GitHub
BTSEPADirectDebitRequest
Parameters for creating a SEPA Direct Debit tokenization request.
See more
Declaration
Swift

@objcMembers public class BTSEPADirectDebitRequest : NSObject
Show on GitHub