Stripe Terminal iOS SDK

For information on migrating from beta versions of the iOS SDK, see the Stripe Terminal Beta Migration Guide.

Requirements

The Stripe Terminal iOS SDK is compatible with apps supporting iOS 9 and above.

Try the example app

The iOS SDK includes an open-source example app, which you can use to familiarize yourself with the SDK and reader before starting your own integration.

To build the example app from source, you’ll need to:

  1. Navigate to the Example folder, and open Example.xcodeproj.
  2. Navigate to our example backend and click the button to deploy it on Heroku.
  3. In AppDelegate.swift, set the URL of the Heroku app you just deployed.
  4. Build and run the app. The SDK comes with a simple reader simulator, so you can get started without any physical hardware.

Note: the example app comes with the Stripe Terminal SDK pre-installed, but uses a few other dependencies. We’ve included pre-built dependencies using Swift 4.2. You may need to run ./setup.sh to re-build the app’s dependencies for your environment.

Installation

We recommend that you install the SDK using CocoaPods. If you prefer to install the library manually, please use the latest version from our releases page.

CocoaPods

  1. If you haven’t already, install the latest version of CocoaPods.

  2. Add this line to your Podfile:

    pod 'StripeTerminal', '1.0.3'
    
  3. Run the following command:

    pod install
    

From now on, don’t forget to use the *.xcworkspace file to open your project in Xcode, instead of the .xcodeproj file.

In the future, to update to the latest version of the SDK, just run:

pod update StripeTerminal

Manual

  1. Navigate to our releases page, download StripeTerminal.framework.zip, and unzip it.

  2. Drag StripeTerminal.framework to the Embedded Binaries section of your Xcode project’s General settings. Make sure to select Copy items if needed.

  3. Navigate to the Build Phases section of your Xcode project settings, and create a new Run Script Build Phase. Paste the following snippet into the text field:

    bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/StripeTerminal.framework/integrate_framework.sh"
    

When new versions of the SDK are released, repeat steps one and two to update your installation

Configure your app

Location services must be enabled in order to use the iOS SDK. Add the following key-value pair to your app’s Info.plist file:

  • Privacy - Location When In Use Usage Description
    • Key: NSLocationWhenInUseUsageDescription
    • Value: Location access is required in order to accept payments.

Note: Stripe needs to know where payments occur to reduce risks associated with those charges and to minimize disputes. If the SDK can’t determine the iOS device’s location, payments are disabled until location access is restored.

For your app to run in the background and remain connected to the reader, add this key-value pair to your Info.plist file:

  • Required background modes
  • Key: UIBackgroundModes
  • Value: bluetoooth-central (Uses Bluetooth LE accessories)
  • Note

    Note the value is actually an array that you will need to add bluetooth-central to.

    For your app to pass validation when submitting to the App Store, add the following key-value pairs as well:

    • Privacy - Bluetooth Peripheral Usage Description
      • Key: NSBluetoothPeripheralUsageDescription
      • Value: “Bluetooth access is required in order to connect to supported bluetooth card readers.”

    Documentation