336be4a0e3
This change adds analytics to the IDV sheet. Specifically, we're logging the following events: - `stripeios.idprod.verification_sheet.presented` - the sheet is presented to the end-user - `stripeios.idprod.verification_sheet.closed` - the sheet is closed by the end-user. Also contains a `session_result` to indicate whether the user successfully completed the IDV flow or closed the sheet to cancel out of the flow. - `stripeios.idprod.verification_sheet.failed` - the sheet failed to open. Also contains an `error_dictionary` containing the error code, domain, and userInfo dictionary for the error that caused the sheet to fail to open. |
||
|---|---|---|
| .circleci | ||
| .github | ||
| BuildConfigurations | ||
| Example | ||
| FauxPasConfig | ||
| IntegrationTester | ||
| LocalizationTester | ||
| OriginalAssets/Stripe.xcassets | ||
| Stripe | ||
| Stripe.xcodeproj | ||
| Stripe.xcworkspace | ||
| Stripe3DS2 | ||
| StripeCore | ||
| StripeiOSResources | ||
| Tests | ||
| ci_scripts | ||
| docs | ||
| fastlane | ||
| stripe3ds2-support | ||
| .clang-format | ||
| .cocoapods.yml | ||
| .gitignore | ||
| .jazzy.yaml | ||
| .swift-format | ||
| .swiftlint.yml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Cartfile.private | ||
| Cartfile.resolved | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| MIGRATING.md | ||
| PRIVACY.md | ||
| Package.swift | ||
| README.md | ||
| STYLEGUIDE.md | ||
| Stripe-umbrella.h | ||
| Stripe.podspec | ||
| StripeCore.podspec | ||
| VERSION | ||
| ui-examples.png | ||
README.md
Stripe iOS SDK
The Stripe iOS SDK makes it quick and easy to build an excellent payment experience in your iOS app. We provide powerful and customizable UI screens and elements that can be used out-of-the-box to collect your users' payment details. We also expose the low-level APIs that power those UIs so that you can build fully custom experiences.
Get started with our 📚 integration guides and example projects, or 📘 browse the SDK reference.
Updating to a newer version of the SDK? See our migration guide and changelog.
Table of contents
Features
Simplified Security: We make it simple for you to collect sensitive data such as credit card numbers and remain PCI compliant. This means the sensitive data is sent directly to Stripe instead of passing through your server. For more information, see our Integration Security Guide.
Apple Pay: We provide a seamless integration with Apple Pay.
SCA-Ready: The SDK automatically performs native 3D Secure authentication if needed to comply with Strong Customer Authentication regulation in Europe.
Stripe API: We provide low-level APIs that correspond to objects and methods in the Stripe API. You can build your own entirely custom UI on top of this layer, while still taking advantage of utilities like STPCardValidator to validate your user’s input.
Native UI: We provide native screens and elements to collect payment details. For example, PaymentSheet is a prebuilt UI that combines all the steps required to pay - collecting payment details, billing details, and confirming the payment - into a single sheet that displays on top of your app.
Card scanning: We support card scanning on iOS 13 and higher. See our Card scanning section.
Localized: We support the following localizations: Chinese (Hong Kong), Chinese (Simplified), Chinese (Traditional), Danish, Dutch, English (US), English (United Kingdom), Finnish, French, French (Canada), German, Hungarian, Italian, Japanese, Korean, Maltese, Norwegian Bokmål, Norwegian Nynorsk (Norway), Portuguese (Brazil), Portuguese, Russian, Spanish, Spanish (Latin America), Swedish, and Turkish.
Recommended usage
If you're selling digital products or services that will be consumed within your app, (e.g. subscriptions, in-game currencies, game levels, access to premium content, or unlocking a full version), you must use Apple's in-app purchase APIs. See the App Store review guidelines for more information. For all other scenarios you can use this SDK to process payments via Stripe.
Releases
We support Cocoapods, Carthage, and Swift Package Manager. If you link the library manually, use a version from our releases page. Make sure to embed both Stripe.xcframework and Stripe3DS2.xcframework.
If you're reading this on GitHub.com, please make sure you are looking at the tagged version that corresponds to the release you have installed. Otherwise, the instructions and example code may be mismatched with your copy. You can read the latest tagged version of this README and browse the associated code on GitHub using this link.
Requirements
The Stripe iOS SDK requires Xcode 11 or later and is compatible with apps targeting iOS 11 or above. We support Catalyst on macOS 10.15 or later.
For iOS 10 support, please use v19.4.0. If you need to support iOS 9, use v17.0.2.
Getting Started
Integration
Get started with our 📚 integration guides and example projects, or 📘 browse the SDK reference for fine-grained documentation of all the classes and methods in the SDK.
Examples
- Prebuilt UI
- This example demonstrates how to build a payment flow using our prebuilt UI component integration
PaymentSheet.
- This example demonstrates how to build a payment flow using our prebuilt UI component integration
- Non-Card Payment Examples
- This example demonstrates how to use
STPAPIClientto manually accept various non-card payment methods.
- This example demonstrates how to use
Card scanning
Our new PaymentSheet UI offers built-in card scanning. To enable card scanning, you'll need to set NSCameraUsageDescription in your application's plist, and provide a reason for accessing the camera (e.g. "To scan cards"). Card scanning is supported on devices with iOS 13 or higher.
You can demo this feature in our PaymentSheet example app. When you run the example app on a device, you'll see a "Scan Card" button when adding a new card.
Contributing
We welcome contributions of any kind including new features, bug fixes, and documentation improvements. Please first open an issue describing what you want to build if it is a major change so that we can discuss how to move forward. Otherwise, go ahead and open a pull request for minor changes such as typo fixes and one liners.
Running Tests
- Install Carthage 0.37 or later (if you have homebrew installed,
brew install carthage) - From the root of the repo, run
bundle install && bundle exec fastlane stripeios_tests. This will install the test dependencies and run the tests. - Once you have run this once, you can also run the tests in Xcode from the
StripeiOStarget inStripe.xcworkspace. Make sure to use the iPhone 8, iOS 13.7 simulator so the snapshot tests will pass.
Migrating from Older Versions
See MIGRATING.md