Braintree iOS SDK

Welcome to Braintree's iOS SDK. This library will help you accept card and alternative payments in your iOS app.

v6 is the latest major version of Braintree iOS and is currently in Beta. For stable releases, please point to v5 of the SDK. While preparing for general availability, we expect to make breaking changes in the beta releases. To update from v5, see the v6 migration guide.

The Braintree iOS SDK permits a deployment target of iOS 14.0 or higher. It requires Xcode 14+ and Swift 5.7+.

Supported Payment Methods

• Credit Cards
• PayPal
• Pay with Venmo
• Apple Pay
• ThreeDSecure
• Visa Checkout

Installation

We recommend using Swift Package Manager, CocoaPods, or Carthage to integrate the Braintree SDK with your project.

Swift Package Manager

This feature is only available in v5+.

To add the Braintree package to your Xcode project, select File > Swift Packages > Add Package Dependency and enter https://github.com/braintree/braintree_ios as the repository URL. Tick the checkboxes for the specific Braintree libraries you wish to include.

If you look at your app target, you will see that the Braintree libraries you chose are automatically linked as a frameworks to your app (see General > Frameworks, Libraries, and Embedded Content).

BraintreePayPal and BraintreePaymentFlow also require the inclusion of the PayPalDataCollector module.

In your app's source code files, use the following import syntax to include Braintree's libraries:

import BraintreeCore
import BraintreeCard
import BraintreeApplePay
import BraintreePayPal

CocoaPods

# Includes Cards and PayPal
pod 'Braintree'

# Optionally include additional Pods
pod 'Braintree/DataCollector'
pod 'Braintree/Venmo'

Carthage

Braintree 6.0.0+ requires Carthage 0.38.0+ and the --use-xcframeworks option when running carthage update.

Add github "braintree/braintree_ios" to your Cartfile, and add the frameworks to your project.

Note: Long term support for Carthage is not guaranteed. Please update to SPM, if possible. If there are concerns, please comment on this Discussion thread.

Documentation

Start with 'Hello, Client!' for instructions on basic setup and usage.

Next, read the full documentation for information about integrating with additional payment methods, such as PayPal and Venmo, as well as explore our pre-built Drop-In UI offering.

Versions

This SDK abides by our Client SDK Deprecation Policy. For more information on the potential statuses of an SDK check our developer docs.

Versions 4.9.6 and below use outdated SSL certificates and are unsupported.

Demo

A demo app is included in the project. To run it you will need to do the following:

1. Run pod install
   • There is a known M1 mac issue with CocoaPods. See this solution to resolve ffi dependency issues.
2. Resolve the Swift Package Manager packages if needed: File > Packages > Resolve Package Versions or by running swift package resolve in Terminal
3. Open Braintree.xcworkspace in Xcode
4. Select the Demo scheme, and then run

Xcode 14+ is required to run the demo app.

Contributing

We welcome PRs to this repo. See our development doc.

Feedback

The Braintree iOS SDK is in active development, we welcome your feedback!

Here are a few ways to get in touch:

• GitHub Issues - For generally applicable issues and feedback
• Braintree Support / [email protected] - for personal support at any phase of integration

Help

• Read the headers
• Read the Braintree docs
• Check out the reference docs
• Find a bug? Open an issue
• Want to contribute? Check out contributing guidelines and submit a pull request.

License

The Braintree iOS SDK is open source and available under the MIT license. See the LICENSE file for more info.