Stripe Terminal enables you to build your own in-person checkout to accept payments in the physical world. Built on Stripe's payments network, Terminal helps you unify your online and offline payment channels. With the Stripe Terminal iOS SDK, you can connect to pre-certified card readers from your iOS app and drive a customized in-store checkout flow.
Upgrading from an older version of the SDK? See our migration guide for guidance.
The Stripe Terminal iOS SDK is compatible with apps supporting iOS 13 and above.
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:
Examplefolder, and open
Example.xcworkspace(make sure to open the
.xcworkspaceand not the
AppDelegate.swift, set the URL of the Heroku app you just deployed.
We support CocoaPods and Swift Package Manager. If you prefer to install the library manually, please use the latest version from our releases page.
In Xcode, select File > Swift Packages > Add Package Dependency and enter https://github.com/stripe/stripe-terminal-ios
If you haven't already, install the latest version of CocoaPods.
Add this line to your Podfile:
pod 'StripeTerminal', '~> 3.0'
From now on, don't forget to use the
*.xcworkspace file to open your project in Xcode, instead of the
In the future, to update to the latest compatible version of the SDK, just run:
pod update StripeTerminal
Navigate to our releases page, download StripeTerminal.xcframework.zip, and unzip it.
StripeTerminal.xcframework to the Frameworks, Libraries, and Embedded Content section of your Xcode project’s General settings. Make sure to select "Copy items if needed".
When new versions of the SDK are released, repeat the above steps to update your installation.
Location services must be enabled in order to use the iOS SDK. Add the following key-value pair to your app's
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
bluetooth-central(Uses Bluetooth LE accessories)
For your app to pass validation when submitting to the App Store, add the following key-value pairs as well:
We maintain an archive of the API reference for the previous major version.
|Last commit: 1 week ago|
retrieveSetupIntentno longer require a connected reader.
SCPCharge.authorizationCodeto the sdk's
SCPChargemodel when it is available.
2.18or later to be installed on your internet reader.
SCPReaderNetworkStatushas a new case (
SCPReaderStatusUnknown) that represents the network status of an internet reader that was discovered while the SDK is operating in offline mode.
SCPSetupIntentStatusRequiresConfirmationafter the payment has been collected.
SCPErrorSessionExpiredwhen the SDK comes back online while using offline mode.