Stripe 终端 iOS SDK

借助 Stripe 终端,您可以构建自己的线下结账流程,以便在线下场景中接受付款。终端基于 Stripe 的支付网络构建,可帮助您统一线上和线下支付渠道。借助 Stripe 终端 iOS SDK,您可以从您的 iOS 应用程序连接到预认证读卡器,并驱动定制化的店内结账流程。

请访问我们的集成指南示例集成开始使用,或浏览 SDK 参考文档

要从旧版本的 SDK 升级?请参阅我们的迁移指南以获取指导。

要求

Stripe 终端 iOS SDK 与支持 iOS 14 及更高版本的应用程序兼容。

试用示例应用程序

iOS SDK 包含一个开源示例应用程序,您可以使用它来熟悉 SDK 和读卡器,然后再开始您自己的集成。

要从源代码构建示例应用程序,您需要

  1. 导航到 Example 文件夹,并打开 Example.xcworkspace(确保打开 .xcworkspace 而不是 .xcodeproj)。
  2. 导航到我们的示例后端,然后单击按钮以将其部署在 Heroku 上。
  3. AppDelegate.swift 中,设置您刚刚部署的 Heroku 应用程序的 URL。
  4. 构建并运行该应用程序。SDK 附带一个简单的读卡器模拟器,因此您无需任何物理硬件即可开始使用。

安装

我们支持 CocoaPods 和 Swift Package Manager。如果您希望手动安装该库,请使用我们发布页面上的最新版本。

Swift Package Manager

在 Xcode 中,选择文件 > Swift Packages > 添加 Package Dependency,然后输入 https://github.com/stripe/stripe-terminal-ios

CocoaPods

  1. 如果您尚未安装,请安装最新版本的 CocoaPods

  2. 将此行添加到您的 Podfile

pod 'StripeTerminal', '~> 4.0'
  1. 运行以下命令
pod install

从现在开始,请务必使用 *.xcworkspace 文件在 Xcode 中打开您的项目,而不是 .xcodeproj 文件。

将来,要更新到最新兼容版本的 SDK,只需运行

pod update StripeTerminal

手动

  1. 导航到我们的发布页面,下载 StripeTerminal.xcframework.zip,然后解压缩。

  2. StripeTerminal.xcframework 拖到 Xcode 项目“General”(通用)设置的“Frameworks, Libraries, and Embedded Content”(框架、库和嵌入式内容)部分。确保选择“Copy items if needed”(如果需要则复制项目)。

当发布新版本的 SDK 时,重复上述步骤以更新您的安装。

配置您的应用程序

必须启用位置服务才能使用 iOS SDK。将以下键值对添加到您的应用程序的 Info.plist 文件中

注意:Stripe 需要知道付款发生的地点,以降低与这些收费相关的风险并最大程度地减少争议。如果 SDK 无法确定 iOS 设备的位置,则付款将被禁用,直到位置访问权限恢复为止。

为了使您的应用程序在后台运行并保持与读卡器的连接,请将此键值对添加到您的 Info.plist 文件中

为了使您的应用程序在提交到 App Store 时通过验证,还需要添加以下键值对

以前的 API 参考

我们维护了以前主要版本的 API 参考的存档。