Braintree iOS SDK

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

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

Supported Payment Methods & Features

• American Express
• Apple Pay
• Credit Cards
• Data Collector (Device data collection for fraud detection)
• Local Payment Methods
• PayPal
• PayPal Messaging (Pay Later Offers)
• Pay with Venmo
• Shopper Insights
• ThreeDSecure
• SEPA Direct Debit
• UI Components
  • PayPal Button
  • Venmo Button
  • PayPal Pay Later Button
  • Credit Card Fields

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

⚠️ Deprecation Notice: CocoaPods support for braintree_ios is no longer supported, the final version with CocoaPods support is version 7.13.1 in line with the official CocoaPods deprecation announcement. Going forward, we recommend migrating to Swift Package Manager (primary) or Carthage. You may also use the direct xcframeworks for manual integrations

# Includes Cards and PayPal
pod 'Braintree'

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

Migrating from CocoaPods to Swift Package Manager

1. Remove the Braintree pod(s) from your Podfile and run pod deintegrate.
2. In Xcode, go to File → Add Package Dependencies… and enter https://github.com/braintree/braintree_ios as the repository URL.
3. Select the specific Braintree libraries you need (e.g. BraintreeCore, BraintreeCard, BraintreePayPal) — see the Swift Package Manager section above.
4. Update import statements if needed; module names are unchanged.
5. Delete Podfile, Podfile.lock, and the .xcworkspace (if it existed only for CocoaPods), and reopen the project via Braintree.xcodeproj.

If SPM isn't an option, Carthage remains supported below.

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.

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.

This is the beginning of the README. Read the rest at the original. Read the full README ↗