Set Up Your Client

important
The SSL certificates for all Braintree SDKs are set to expire by June 30, 2025. This will impact existing versions of the SDK in published versions of your app. To reduce the impact, upgrade the iOS SDK to version 6.17.0+ for the new SSL certifications.
If you do not decommission your app versions that include the older SDK versions or force upgrade your app with the updated certificates by the expiration date, 100% of your customer traffic will fail.

You can collect customer payment information via the client SDK in a number of ways:

Accept more payment types with your existing checkout form by adding buttons for PayPal, Apple Pay, Google Pay, and Venmo.
Rolling your own checkout UI? Use credit card tokenization to save customer card information.

iOS SDK setup

note
BT iOS v6 SDK does not support the Drop-In UI. Please refer to the iOS v5 SDK docs for more information on Drop-In UI setup.

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

Using CocoaPods

Add Braintree to your Podfile:

Ruby

# Includes Cards and PayPal
pod 'Braintree'

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

Then run pod install.

Using 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. Feel free to bring up any concerns here.

Get a client token

Client tokens are optional: You can initialize Braintree with a tokenization key instead of a client token. If you are using a tokenization key, you may skip this section and use the tokenization key for your authorization instead.

Your server is responsible for generating a client token, which contains the authorization and configuration details that your client needs to initialize the client SDK.

Your app should request a client token from your server. This example uses our sample integration server; please adapt it to use your own backend API.

Swift

func fetchClientToken() {
    // TODO: Switch this URL to your own authenticated API
    let clientTokenURL = URL(string: "https://braintree-sample-merchant.herokuapp.com/client_token")!
    let clientTokenRequest = URLRequest(url: clientTokenURL)
    clientTokenRequest.setValue("text/plain", forHTTPHeaderField: "Accept")

    URLSession.shared.dataTask(with: clientTokenRequest) { data, response, error in
        // TODO: Handle errors
        let clientToken = String(data: data!, encoding: .utf8)

        // As an example, you may wish to present Drop-in at this point.
        // Continue to the next section to learn more...
        }.resume()
}

You should obtain a new client token frequently, at least once a day or as often as your app restarts. For the best experience, you should kick off this network operation before it would block a user interaction.

Try it now

We generated a demo tokenization key for you so you can jump right in. This is for testing purposes only! When you're ready to build your own integration, use your own tokenization key or generate your own client token.

Swift

let authorization = "sandbox_f252zhq7_hh4cpc39zq4rgjcg"

The above demo client token is for temporary use. You must change this client token in order to process payments with your Braintree sandbox or production account.

Test your integration

Create a sandbox account

If you haven't already, sign up for a free Braintree sandbox account:

Sandbox merchant ID
Public key
Private key

Use these credentials for your development and testing.

important
When you go live, you will need to replace your sandbox API credentials with production API credentials.

Test values

When testing in the sandbox, be sure to use our test card numbers (e.g. 4111111111111111) and nonces (e.g. fake-valid-nonce). Real payment method data will not work in the sandbox. See our Testing page for more details.

Send payment method nonce to server

Send the resulting payment method nonce to your server (again, adapt this example to your own setup):

Swift

func postNonceToServer(paymentMethodNonce: String) {
    // Update URL with your server
    let paymentURL = URL(string: "https://your-server.example.com/payment-methods")!
    var request = URLRequest(url: paymentURL)
    request.httpBody = "payment_method_nonce=(paymentMethodNonce)".data(using: .utf8)
    request.httpMethod = "POST"

    URLSession.shared.dataTask(with: request) { (data, response, error) -> Void in
        // TODO: Handle success or failure
    }.resume()
}

world.greeted = true

At this point, you should have a working client-side checkout flow. When your user provides payment information, you receive a payment method nonce and send it to your server.

Next, your server closes the loop by using the payment method nonce to create a transaction.

Next Page: Simple Server →