Welcome to PayPal's iOS SDK. This library will help you accept card, PayPal, Venmo, and alternative payment methods in your iOS app.
The SDK is currently in the development process. This product is being developed fully open source - throughout the development process, we welcome any and all feedback. Aspects of the SDK will likely change as we develop the SDK. We recommend using the SDK in the sandbox environment until an official release is available. This README will be updated with an official release date once it is generally available.
As the SDK is moved to general availability, we will be adding a contribution guide for developers that would like to contribute to the SDK. If you have suggestions for features that you would like to see in future iterations of the SDK, please feel free to open an issue, PR, or discussion with suggestions. If you want to open a PR but are unsure about our testing strategy, we are more than happy to work with you to add tests to any PRs before work is merged.
The PayPal iOS SDK supports a minimum deployment target of iOS 14+ and requires Xcode 14.0+ and macOS Monterey 12. See our Client Deprecation policy to plan for updates.
This SDK supports:
- CocoaPods
- Swift Package Manager
This SDK supports Swift 5.7+. This SDK is written in Swift.
This SDK supports:
- UIKit
- SwiftUI
The PayPal SDK uses a client ID for authentication. This can be found in your PayPal Developer Dashboard.
Each feature module has its own onboarding guide:
To accept a certain payment method in your app, you only need to include that payment-specific submodule.
This project uses the XCTest framework provided by Xcode. Every code path should be unit tested. Unit tests should make up most of the test coverage, with integration, and then UI tests following.
This project also takes advantage of Fastlane to run tests through our CI and from terminal.
In order to invoke our unit tests through terminal, run the following commands from the root level directory of the repository:
bundle install
bundle exec fastlane unit_tests
If you would like to get the code coverage for all of the modules within the workspace, run the following:
bundle install
bundle exec fastlane coverage
GitHub Actions CI will run all tests and build commands per package manager on each PR.
TBD until development progresses. We will use Rake, Fastlane, or some other tool for easy command-line build tasks.
This SDK follows Semantic Versioning. The release process will be automated via GitHub Actions.
Client analytics will be collected via Lighthouse/FPTI.