availability

Braintree Auth is in closed beta. To request access, email auth@braintreepayments.com.

The following Connect flow will guide merchants through authorization in your iOS app without exposing your client_secret:

  1. The merchant taps the Connect with Braintree button in your app
  2. Your app sends the merchant to Braintree for authorization using an SFSafariViewController
  3. Once the merchant has authorized, Braintree redirects them to the redirect_uri specified by the connect_url
  4. Your server performs the OAuth exchange
  5. Your server redirects the merchant to a URL that is captured by a Custom URL Scheme in your mobile app

Button

  1. Download the connect-braintree-ios assets
  2. Add the button images as a new image set in your Xcode project's Asset Catalog
  3. Add a button object to your view, using the assets you added as the button's image
  4. Create an action for your button in your view's controller

Send the merchant to Braintree

Import SafariServices in your view's controller and extend SFSafariViewControllerDelegate.

Once that's done, create a property that holds SFSafariViewController, which you'll define later.

Objective-C Swift
// ViewController.m

@import SafariServices;

@interface ViewController () <SFSafariViewControllerDelegate>
@property SFSafariViewController *safariVC;
@end

In the button action you created earlier, instantiate an SFSafariViewController with a connect_url retrieved from your server:

Objective-C Swift
- (IBAction)connectAction:(UIButton *)sender {
    SFSafariViewController *safariVC = [[SFSafariViewController alloc]initWithURL:[NSURL URLWithString: CONNECT_URL_FROM_SERVER]];
    self.safariVC = safariVC;
    safariVC.delegate = self;
    [self presentViewController:safariVC animated:NO completion:nil];
}

Prepare for the merchant's return

Now that you have a way of sending the merchant to Braintree, you'll need to make sure they have a way of returning to your app.

Next, add an observer in the viewDidLoad method of your view's controller to handle the redirect from Braintree:

Objective-C Swift
- (void)viewDidLoad {
    [super viewDidLoad];
    [[NSNotificationCenter defaultCenter]
        addObserver:self
        selector:@selector(braintreeLogin:)
        name:@"braintreeConnectedRedirectNotification"
        object:nil];
}

Finally, define the corresponding braintreeLogin callback to dismiss the Safari view:

Objective-C Swift
- (void) braintreeLogin:(NSNotification *) notification {
    [self.safariVC dismissViewControllerAnimated: true completion: nil];
    // perform any additional actions like transitioning to another view here
}

Capturing the custom URL

After performing the OAuth exhange, your server will redirect your merchant back to a custom URL that your app will capture. To do that, we'll need to define URL schemes and define a function in your app's AppDelegate.

URL schemes

Update your project's Info.plist CFBundleURLTypes property to enable your app to handle custom URL schemes:

XML
<key>CFBundleURLTypes</key>
  <array>
    <dict>
      <key>CFBundleTypeRole</key>
      <string>Editor</string>
      <key>CFBundleURLName</key>
      <string>authredirect</string>
      <key>CFBundleURLSchemes</key>
      <array>
        <string>examplescheme</string>
      </array>
    </dict>
  </array>

Application delegate

Define a function to handle the custom URL in your AppDelegate that will ensure the URL is from a trusted source and broadcast an event to our view:

Objective-C Swift
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
    [[NSNotificationCenter defaultCenter] postNotificationName: @"braintreeConnectedRedirectNotification" object: nil];
    return YES;
}
important

Your server should not send sensitive information to the client via the custom URL, since multiple iOS apps are able to intercept custom URL schemes.

Broadcasting this event will trigger the braintreeLogin callback you defined earlier in your view's controller. This brings the merchant back into your application and completes the authorization flow.

Next: OAuth Flow →

Still have questions?

If you can’t find an answer, contact our Support team.