Home

Awesome

Braintree iOS SDK

CocoaPods compatible Swift Package Manager compatible Carthage compatible

GitHub Actions Tests

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

📣 Announcements

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

Supported Payment Methods

Installation

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

Swift Package Manager

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 BraintreeLocalPayment also require the inclusion of the BraintreeDataCollector 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.

Upgrade Your SDK Version

If you're looking to update to a newer version of our SDK, please see our recommended approach below.

Using Swift Package Manager

To update using Swift Package Manager, select File→ Packages → Update to Latest Package Versions.

Using Cocoapods

You can either update all pods listed within your Podfile using pod update or specific pods as needed using pod update PODNAME. For additional details, see the Cocoapods guidelines.

Using Carthage

To update to the latest versions of each framework, simply run the carthage update command. For more details, check out the Carthage guidelines.

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 numberStatusReleasedDeprecatedUnsupported
6.x.xActiveJune 2023TBATBA
5.x.xInactiveFebruary 2021June 2024June 2025
4.x.xUnsupportedNovember 2015February 2022February 2023

Demo

  1. Our Xcode project uses SwiftLint. To ensure you have it installed see DEVELOPMENT.md
  2. Run pod install
  3. Resolve the Swift Package Manager packages if needed: File > Packages > Resolve Package Versions or by running swift package resolve in Terminal
  4. Open Braintree.xcworkspace in Xcode
  5. Select the Demo scheme, and then run

Xcode 15.0+ 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:

Help

License

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