SDK to B2B API Migration Process

In November 2018, PayPal deprecated its Android and iOS white label wallet (WLW) mobile SDKs and announced its intention to suspend support of the mobile SDKs in December 2019 in support of the more streamlined server-side architecture favored by the emerging mobile payments industry. The B2B Mobile Transaction API:

  • Allows for faster adoption of new features without SDK upgrade.
  • Eliminates dependency on PayPal for OS support and regression testing for a comprehensive suite of features potentially not implemented by individual business processes.
  • Minimizes app size and complexity.
  • Aligns all integration entry to the PayPal WLW platform with a consistent model.
  • Affords device agnostic integration with the PayPal WLW platform.

If your mobile app is still using the SDK infrastructure, use this article to transition to the new B2B API implementation.

Process overview

  1. Configure an app server to route calls from your mobile app as API requests through PayPal's B2B Gateway.
  2. Remove the PayPal WLW mobile SDK instance from your iOS and Android apps.
  3. Recode non-transaction related app operations to be managed internally.
  4. Test your apps according to PayPal's minimum test plan requirements and submit the apps for certification with the PayPal WLW platform.

Configure your app server

In the new server-side architecture, your app communicates directly with your integrated app server that will interface with the PayPal WLW platform via the B2B API. The app server must be configured as follows:

  • The app server must secure authorization credentials to call PayPal's WLW B2B API.
  • The app server must ensure that sensitive account data is handled in accordance with PCI regulations. See PCI compliance guidelines for more information about PCI.

Remove PayPal white label wallet SDK from your apps

Uninstall the PayPal WLW mobile SDK package from your app development environment, including all environment variables, error mapping, logging, response handling, etc. Recode all in-app mobile wallet operations based on whether they are supported mobile transaction operations or non-transaction operations.

Redirect mobile transaction operations to the B2B API through your app server

Recode the calls from your app that are related to transaction processing so the app server can translate them to the corresponding B2B API endpoints. The following table provides a map of the iOS SDK methods (corresponding Android methods are in most cases identical or nearly identical) that have B2B API endpoint equivalents.

Click a B2B endpoint name to jump to the API documentation for that endpoint.

iOS Method B2B API Endpoint
registerNewUser CreateCustomer
updateUserProfile UpdateCustomer
retrieveCustomerDetails RetrieveCustomer
startPaymentAccountEnrollment StartPaymentAccountEnrollment
continuePaymentAccountEnrollment ContinuePaymentAccountEnrollment
retrieveIncompletePaymentAccountEnrollments RetrieveIncompletePaymentAccountEnrollment
cancelPaymentAccountEnrollment CancelPaymentAccountEnrollment
retrieveReceiptDetail RetrieveUserReceiptByPaydiantRefId
retrieveReceipts RetrievePaginatedUserReceipts
obtainCheckoutTokenFor ObtainMobileDeviceCheckoutToken
releaseCheckoutToken ReleaseMobileDeviceCheckoutToken
retrieveTransactionMetadata RetrieveMobileTransactionMetadata or RetrieveMobileTransactionMetadata Webhook
updateTransaction UpdateMobileTranscation
cancelTransactionUsingToken CancelMobileTransaction

Recode non-transaction operations

The SDK managed the whole mobile wallet experience, including app authentication, device fingerprinting, network connectivity, QR code scanning and decoding, push notification registration, promotional offer activation and redemption, loyalty activity, and event logging. The new server-side architecture no longer controls these non-transaction aspects of the app experience, so the SDK calls related to them need to be refactored to be handled in whatever way suits your business process and existing infrastructure.

In particular, these areas of functionality require a merchant-driven solution:

  • Identity Management (user profile data, authentication & credential management)
  • Device Management (device/user linking, push notifications)
  • Payment Account Management (may be a hybrid approach)
  • Loyalty
  • Remote Orders
  • In-app Offers
  • Error Mapping
  • Logging

See the SDK Method Matrix for a complete index of all SDK methods and their role in the new architecture.

Test and certify new apps

Once you have reworked your apps and app server to support the sever side implementation, consult your PayPal WLW representative to coordinate a test plan and certification that is appropriate for your implementation.

Additional information

Take a look at our FAQ page for answers to the most common questions related to the B2B Mobile Transaction API.

If your question is not addressed, email support.

Feedback