Need help with braintree_ios?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

braintree
499 Stars 273 Forks MIT License 3.4K Commits 9 Opened issues

Description

Braintree SDK for iOS

Services available

!
?

Need anything else?

Contributors list

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.

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+.

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.

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.

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. 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.

| 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.

Demo

A demo app is included in the project. To run it, run

pod install
and then open
Braintree.xcworkspace
in Xcode. Xcode 13+ 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.