Braintree iOS SDK
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 requires Xcode 12+. It permits a Deployment Target of iOS 12.0 or higher.
Supported Payment Methods
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.
See our Swift Package Manager guide for instructions on integrating with SPM.
CocoaPods
# 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.
Carthage
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. Open a GitHub issue if there are concerns.
Documentation
Start with 'Hello, Client!' for instructions on basic setup and usage.
Next, read the full documentation for information about integration options, such as Drop-In UI, PayPal, and credit card tokenization.
Versions
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 3 and below are unsupported.
Demo
A demo app is included in the project. To run it, run pod install and then open Braintree.xcworkspace in Xcode.
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 / support@braintreepayments.com - 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.