Welcome to Braintree's iOS SDK. This library will help you accept card and alternative payments in your iOS app.
v5 is the latest major version of Braintree iOS. To update from v4, see the v5 migration guide.
The Braintree iOS SDK permits a deployment target of iOS 12.0 or higher. It requires Xcode 12+ and Swift 5.1+.
We recommend using Swift Package Manager, CocoaPods, or Carthage to integrate the Braintree SDK with your project.
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
Braintree 5.4.2+ requires Xcode 12.5+ for SPM. We recommend using the latest version for the simplest SPM integration. If using Braintree 5.4.1 and below, please see our Swift Package Manager guide for specific workarounds required to use these older versions.
# Includes Cards and PayPal
pod 'Braintree'
# Optionally include additional Pods
pod 'Braintree/DataCollector'
pod 'Braintree/Venmo'
Note: If you are using version 4.x.x of the Braintree iOS SDK in Xcode 12, you may see the warning The iOS Simulator deployment target is set to 8.0, but the range of supported deployment target versions is 9.0 to 14.0.99. This will not prevent your app from compiling. This is a CocoaPods issue with a known workaround.
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.
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.
This SDK abides by our Client SDK Deprecation Policy. For more information on the potential statuses of an SDK check our developer docs.
| Major version number | Status | Released | Deprecated | Unsupported |
|---|---|---|---|---|
| 5.x.x | Active | February 2021 | TBA | TBA |
| 4.x.x | Inactive | November 2015 | February 2022 | February 2023 |
Versions 4.9.6 and below use outdated SSL certificates and are unsupported.
A demo app is included in the project. To run it you will need to do the following:
1. Run pod install
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.
Xcode 13+ is required to run the demo app.
We welcome PRs to this repo. See our development doc.
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
- 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.
The Braintree iOS SDK is open source and available under the MIT license. See the LICENSE file for more info.