The PayPal Android SDK makes it easy to add PayPal and credit card payments to mobile apps.
This documentation is available in Japanese: 日本語のドキュメント.
- Use Cases
- Integration with the PayPal Wallet App
- Requirements
- Add the SDK to Your Project
- Credentials
- International Support
- Disabling card.io card scanning
- Completely Disabling Direct Credit Card Payments
- Override
minSdkVersion - Testing
- Documentation
- Usability
- Dependency Conflicts
- Moving to PayPal Android SDK 2.0
- Next Steps
- Contributing
- License
The PayPal Android SDK is now available at Maven Repository. The latest version is available via mavenCentral():
compile 'com.paypal.sdk:paypal-android-sdk:2.14.4'The SDK supports two use cases for making payments - Single Payment and Future Payments - and a third use case for obtaining information about the customer - Profile Sharing.
Receive a one-time payment from a customer's PayPal account or payment card (scanned with card.io). This can be either (1) an immediate payment which your servers should subsequently verify, or (2) an authorization for a payment which your servers must subsequently capture, or (3) a payment for an order which your servers must subsequently authorize and capture:
- Accept a Single Payment and receive back a proof of payment.
- On your server, Verify the Payment, Capture the Payment, or Process the Order (PayPal Developer site) using PayPal's API.
Note: Direct Credit Card (DCC) payments are only available in a select few countries. Also, see the International Support section for details on the specific currencies supported.
Your customer logs in to PayPal just one time and consents to future payments:
- Obtain Customer Consent to receive an authorization code.
- On your server, use this authorization code to Obtain OAuth2 Tokens.
Later, when that customer initiates a payment:
- Obtain a Client Metadata ID that you'll pass to your server.
- On your server, Create a Payment using your OAuth2 tokens, the Client Metadata ID, and PayPal's API.
Your customer logs in to PayPal and consents to PayPal sharing information with you:
- Obtain Customer Consent to receive an authorization code.
- On your server, use this authorization code to Obtain OAuth2 Tokens.
- On your server, Retrieve Customer Information using your OAuth2 tokens and PayPal's API.
The SDK will now use the newest version of the PayPal Wallet App if present on the device to log in to a customer account. No additional configuration is required to enable this feature. This integration enables device-specific PayPal FIDO integrations, including login by fingerprint on the Galaxy S5. In addition, a user who logged in to the PayPal Wallet App and checked "Keep me logged in" may not need to log-in again when paying with your app. For more information on how this all works, please read the blog post from one of our architects.
- The integration will not be enabled in any of the testing modes, as the Wallet app does not support this developer testing environment.
- Android 4.1.x (API 16) or later
- Phone or tablet
Your mobile integration requires different client_id values for each environment: Live and Test (Sandbox).
Your server integrations for verifying or creating payments will also require the corresponding client_secret for each client_id.
You can obtain these PayPal API credentials by visiting the Applications page on the PayPal Developer site and logging in with your PayPal account.
Once logged in on this Applications page, you will be assigned test credentials, including Client ID, which will let you test your Android integration against the PayPal Sandbox.
While testing your app, when logging in to PayPal in the SDK's UI you should use a personal Sandbox account email and password. I.e., not your Sandbox business credentials.
You can create both business and personal Sandbox accounts on the Sandbox accounts page.
PayPal will be upgrading the endpoint that the PayPal Android SDK uses to communicate with PayPal servers on Jan 18th, 2016. If you're testing on sandbox with a version of the PayPal Android SDK older than 2.13.0, then you'll start seeing communication failures when using Android devices >= API 16, and < API 20. Please upgrade to a version 2.13.0 or higher to fix these errors.
If you're testing on a device older than API 16, Android will not be able to communicate with PayPal, no matter what version of the SDK you use.
These TLS changes coincides with the TLSv1.2 security mandate outlined here, and will be followed by a similar change to the Production endpoints at some later date. For any questions or concerns, please create an issue.
To obtain your live credentials, you will need to have a business account. If you don't yet have a business account, there is a link at the bottom of that same Applications page that will get you started.
The SDK has built-in translations for many languages and locales. See javadoc files for a complete list.
The SDK supports multiple currencies. See the REST API country and currency documentation for a complete, up-to-date list.
Note that currency support differs for credit card versus PayPal payments. Unless you disable credit card acceptance (via the PaymentActivity.EXTRA_SKIP_CREDIT_CARD intent extra), we recommend limiting transactions to currencies supported by both payment types. Currently these are: USD, GBP, CAD, EUR, JPY.
If your app initiates a transaction with a currency that turns out to be unsupported for the user's selected payment type, then the SDK will display an error to the user and write a message to the console log.
Future payments does not require card.io card scanning. Also, for single payments, if you do not wish to include the scanning feature of card.io, and only allow manual entry by keyboard, add packagingOptions to remove the .so libraries of card.io in your build.gradle:
android {
packagingOptions {
exclude 'lib/arm64-v8a/libcardioDecider.so'
exclude 'lib/arm64-v8a/libcardioRecognizer.so'
exclude 'lib/arm64-v8a/libcardioRecognizer_tegra2.so'
exclude 'lib/arm64-v8a/libopencv_core.so'
exclude 'lib/arm64-v8a/libopencv_imgproc.so'
exclude 'lib/armeabi/libcardioDecider.so'
exclude 'lib/armeabi-v7a/libcardioDecider.so'
exclude 'lib/armeabi-v7a/libcardioRecognizer.so'
exclude 'lib/armeabi-v7a/libcardioRecognizer_tegra2.so'
exclude 'lib/armeabi-v7a/libopencv_core.so'
exclude 'lib/armeabi-v7a/libopencv_imgproc.so'
exclude 'lib/mips/libcardioDecider.so'
exclude 'lib/x86/libcardioDecider.so'
exclude 'lib/x86/libcardioRecognizer.so'
exclude 'lib/x86/libcardioRecognizer_tegra2.so'
exclude 'lib/x86/libopencv_core.so'
exclude 'lib/x86/libopencv_imgproc.so'
exclude 'lib/x86_64/libcardioDecider.so'
exclude 'lib/x86_64/libcardioRecognizer.so'
exclude 'lib/x86_64/libcardioRecognizer_tegra2.so'
exclude 'lib/x86_64/libopencv_core.so'
exclude 'lib/x86_64/libopencv_imgproc.so'
}
}If you want to completely disable Direct Credit Card (DCC) payments, exclude the card.io library in your application build.gradle:
dependencies {
compile('com.paypal.sdk:paypal-android-sdk:2.14.4') {
exclude group: 'io.card'
}
}As of release 2.14.0, the minSdkVersion has been increased to 16. If you prefer to have your app on a lower minSdkVersion and want to leverage the latest SDK, please disable PayPal for versions below API 16, add xmlns:tools="http://schemas.android.com/tools inside the manifest's xml declaration, and add the following snippet to your AndroidManifest.xml:
<uses-sdk android:minSdkVersion="INSERT_YOUR_DESIRED_minSdkVersion_HERE" tools:overrideLibrary="com.paypal.android.sdk.payments"/>See the Android manifest merger docs for more information.
During development, use environment() in the PayPalConfiguration object to change the environment. Set it to either ENVIRONMENT_NO_NETWORK or ENVIRONMENT_SANDBOX to avoid moving real money.
- These docs in the SDK, which include an overview of usage, step-by-step integration instructions, and sample code.
- The sample app included in this SDK.
- There are javadocs available.
- The PayPal Developer Docs, which cover error codes and server-side integration instructions.
User interface appearance and behavior is set within the library itself. For the sake of usability and user experience consistency, apps should not attempt to modify the SDK's behavior beyond the documented methods.
As a major version change, the API introduced in 2.0 is not backward compatible with 1.x integrations. However, the SDK still supports all previous single payment functionality. Upgrading is straightforward.
- Most of the non-payment-specific extras of
PayPalPaymentActivityhave been moved to thePayPalConfigurationclass, and the service startup has changed to take such a configuration object.
PayPal is in the process of replacing the older "Mobile Payments Libraries" (MPL) with the new PayPal Android and iOS SDKs. The new Mobile SDKs are based on the PayPal REST API, while the older MPL uses the Adaptive Payments API.
Until features such as third-party, parallel, and chained payments are available, if needed, you can use MPL:
Issues related to MPL should be filed in the sdk-packages repo.
Developers with existing Express Checkout integrations or who want additional features may wish to use Mobile Express Checkout in a webview.
Depending on your use case, you can now:
Please read our contributing guidelines prior to submitting a Pull Request.
Please refer to this repo's license file.