iOS v3 is deprecated. We recommend migrating to the latest version of our iOS SDK. The best way to start is by making an incremental upgrade from v3 to v4.

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

Client side payment token flow Diagram demonstrating the required interaction between the client, Braintree servers and your server.

iOS SDK setup

These instructions are for version 3.x of our iOS SDK. We recommend using the latest version of our SDK; use the selector near the top of this page.

For additional requirements and installation options, see the iOS Client SDK Guide.

Using CocoaPods

Add Braintree to your Podfile:

pod 'Braintree', '~> 3.9'

Then run pod install.


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.

Initialize Braintree

In your checkout controller or wherever else you handle orders and payments, declare a property:

#import <Braintree/Braintree.h>

@interface MyViewController ()
@property (nonatomic, strong) Braintree *braintree;

Get a client token

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.

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    // TODO: Switch this URL to your own authenticated API
    NSURL *clientTokenURL = [NSURL URLWithString:@"https://braintree-sample-merchant.herokuapp.com/client_token"];
    NSMutableURLRequest *clientTokenRequest = [NSMutableURLRequest requestWithURL:clientTokenURL];
    [clientTokenRequest setValue:@"text/plain" forHTTPHeaderField:@"Accept"];

    [[[NSURLSession sharedSession] dataTaskWithRequest:clientTokenRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        // TODO: Handle errors
        NSString *clientToken = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];

        // Initialize `Braintree` once per checkout session
        self.braintree = [Braintree braintreeWithClientToken:clientToken];

        // As an example, you may wish to present our Drop-in UI 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 client token for you so you can jump right in. This is for testing purposes only!

NSString *clientToken = @"CLIENT_TOKEN_FROM_SERVER";

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.

Present Drop-in UI

At this point, you are ready to collect payment information from your customer.

Drop-in is the easiest way to get started. It provides a fully fledged payments experience out of the box. You can also choose to create a custom UI and then tokenize the payment information directly.

Declare a class that conforms to the BTDropInViewControllerDelegate protocol to receive the user's payment method.

#import <Braintree/Braintree.h>

@interface MyViewController () <BTDropInViewControllerDelegate>

@property (nonatomic, strong) Braintree *braintree;


In your implementation, use the client token obtained from your server to initialize the Braintree SDK. Then, create a BTDropInViewController.

#import "MyViewController.h"

@implementation MyViewController

// ...

// With this example, you should ensure that your users can't tap the pay button until
// the client token has been obtained from your server and has been used to create a
// Braintree instance.

- (IBAction)tappedMyPayButton {

  // If you haven't already, create and retain a `Braintree` instance with the client token.
  // Typically, you only need to do this once per session.
  //self.braintree = [Braintree braintreeWithClientToken:CLIENT_TOKEN_FROM_SERVER];

  // Create a BTDropInViewController
  BTDropInViewController *dropInViewController = [self.braintree dropInViewControllerWithDelegate:self];
  // This is where you might want to customize your Drop in. (See below.)

  // The way you present your BTDropInViewController instance is up to you.
  // In this example, we wrap it in a new, modally presented navigation controller:
  dropInViewController.navigationItem.leftBarButtonItem = [[UIBarButtonItem alloc] initWithBarButtonSystemItem:UIBarButtonSystemItemCancel

  UINavigationController *navigationController = [[UINavigationController alloc] initWithRootViewController:dropInViewController];
  [self presentViewController:navigationController animated:YES completion:nil];

- (void)userDidCancelPayment {
    [self dismissViewControllerAnimated:YES completion:nil];

Then implement BTDropInViewControllerDelegate to obtain the payment method nonce on success, and dismiss the Drop In UI in either case:

- (void)dropInViewController:(__unused BTDropInViewController *)viewController didSucceedWithPaymentMethod:(BTPaymentMethod *)paymentMethod {
    [self postNonceToServer:paymentMethod.nonce]; // Send payment method nonce to your server
    [self dismissViewControllerAnimated:YES completion:nil];

- (void)dropInViewControllerDidCancel:(__unused BTDropInViewController *)viewController {
    [self dismissViewControllerAnimated:YES completion:nil];

Test your integration

Create a sandbox account

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

Sign Up for a Braintree Sandbox Account

Log in to obtain your sandbox API credentials. You'll need your:

  • Sandbox merchant ID
  • Public key
  • Private key

Use these credentials for your development and testing.


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

- (void)postNonceToServer:(NSString *)paymentMethodNonce {
    // Update URL with your server
    NSURL *paymentURL = [NSURL URLWithString:@"https://your-server.example.com/checkout"];
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:paymentURL];
    request.HTTPBody = [[NSString stringWithFormat:@"payment_method_nonce=%@", paymentMethodNonce] dataUsingEncoding:NSUTF8StringEncoding];
    request.HTTPMethod = @"POST";

    [[[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        // TODO: Handle success and 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 →