Mobile SDK Methods Matrix
DOCS
Last updated: Aug 15th, 7:55am
This page provides an index of all PayPal WLW (White Label Wallet) mobile SDK methods, grouped and alphabetically ordered by SDK module, as well as a description of the method's usage and guidance for how that behavior should be handled in a server-side implementation.
Note: This table lists iOS methods for reference. In many cases the Android SDK method is the same or similar.
Authentication
| SDK Method | Purpose | Guidance |
|---|---|---|
loginByUsernamePassword | Log in for the first time or on an unlinked device. | Defined by merchant IDP solution. |
loginByPin | Log into a linked device. | Defined by merchant IDP solution. |
loginByNonce | Log in using external auth, such as SSO or device fingerprint. | Defined by merchant IDP solution. |
loginByFederatedIdentity | Log in through a 3rd party server, like PayPal or Facebook. | Defined by merchant IDP solution. |
isAuthorizedTokenExist | Check for long-lived session credential. | Defined by merchant IDP solution. |
generateDeviceAuthenicationTokenForUsername | Establish a long-lived authentication session. | Defined by merchant IDP solution. |
loginWithDeviceAuthenticationToken | First login with long-lived session. | Defined by merchant IDP solution. |
expireDeviceAuthenticationToken | Terminate a long-lived auth session. | Defined by merchant IDP solution. |
registerWithMFA | Link a device with a user account using multi-factor auth. | Defined by merchant IDP solution. |
Logout | End the current login session. | Defined by merchant IDP solution. |
BLE
| SDK Method | Purpose | Guidance |
|---|---|---|
registerBLEEvents | Identify bluetooth events for which the app is listening. | Not applicable. |
pairBLEEvent | Pair to a detected bluetooth event. | Not applicable. |
Customer
| SDK Method | Purpose | Guidance |
|---|---|---|
retrieveCustomerDetails | Get a user's profile record. | Merchant can get complete profile data from its own IDP, or use B2B API retrieveCustomer to get WLW platform user profile record. |
Decoder
| SDK Method | Purpose | Guidance |
|---|---|---|
startDecoderSession | Activate device camera to scan QR Code. | Not applicable. |
decodeImage | Read QR Code to obtain checkoutToken value. | Not applicable. |
endDecoderSession | Deactivate camera and return to app. | Not applicable. |
Device Management
| SDK Method | Purpose | Guidance |
|---|---|---|
getDeviceIdentifier | Obtain the manufacturer's unique ID for the device. | Merchant responsibility. |
isDeviceSupported | Determine whether the device meets support requirements, like minimum OS version and device type. | Merchant responsibility. |
isDeviceRegistered | Check whether the device is already associated with a user account. | The merchant is expected to link customer and device identifiers. |
resendApplicationInstanceVerificationWithEmail | Send an email to the user associated with the device indicating that the wallet cannot be activated until the app verification is completed by clicking the link provided in the email. | Merchant discretion. |
addAdditionalDeviceInformation | Define custom metadata properties related to the device, such as last login date or password expiration date. | Merchant discretion. |
retrieveAdditionalDeviceInformation | Fetch any custom properties defined for the device. | Merchant discretion. |
updateAdditionalDeviceInformation | Modify custom property values. | Merchant discretion. |
deleteAdditionalDeviceInformation | Remove custom properties defined for the device. | Merchant discretion. |
updateDeviceDescription | Set a user-defined device description, such as "Sarah's phone". | Merchant discretion. |
removeDevice | Decouple the device from the user's mobile wallet account. | Merchant responsibility. |
Loyalty Management
Note: Loyalty Management has been deprecated and is no longer available.
The SDKs provided a variety of methods supporting loyalty program management, such as registering for loyalty, retrieving the current points balance, recording activity that would award points, etc. These operations are no longer managed within the PayPal WLW platform; and any loyalty related behavior built into the merchant app is managed solely by the merchant in the server-side implementation.
Offer Management
Note: Offer Management has been deprecated and is no longer available.
The SDKs provided a variety of methods supporting offer campaign management, such as pulling a set of available offer campaigns, activating specific offers for the individual user, viewing a list of activated offers, etc. These operations are no longer managed within the PayPal WLW platform; and any coupon or discount related behavior built into the merchant app is managed solely by the merchant in the server-side implementation.
Order Management
The SDKs provided methods to retrieve remote order metadata for the purpose of allowing users to review previously submitted orders and duplicate them without having to re-enter all field data. These operations are no longer managed within the PayPal WLW platform; and any remote order related behavior built into the merchant app is managed solely by the merchant in the server-side implementation.
Payment Account Management
| SDK Method | Purpose | Guidance |
|---|---|---|
retrievePaymentAccountConfigurations | Get the merchant specifications for enrolling a particular supported tender in the wallet to ensure that all relevant data fields are presented to the user and values are formatted correctly. | Merchant discretion. |
retrieveBillingAddresses | Get the billing addresses associated with tenders already enrolled in the wallet during launch to minimize performance impact during a transaction. | Merchant discretion. |
retrieveAllPaymentAccounts | Get the WLW platform records for all payment accounts enrolled in the wallet. | Use B2B API retrieveCustomerCardInfo, leaving paymentAccountUri value null to get all accounts for the customer. |
retrieveSpecificPaymentAccount | Get the WLW platform record for a specified payment account in the wallet. | Use B2B API retrieveCustomerCardInfo with a specific paymentAccountUri. |
refreshPaymentAccountBalance | Get the current balance of a payment account in the wallet. | Use B2B API refreshCustomerCardBalances. |
refreshPointsBalance | Deprecated Get the current reward points for a loyalty account. | Merchant discretion based on loyalty program strategy. |
retrieveLoadConfiguration | Get the merchant specifications for loading and reloading payment accounts through the wallet, such as supported denominations and amount minimums/maximums. | Merchant discretion. |
addPaymentAccount | Enroll a single-step, open-loop payment account. | Use B2B API addCustomerCard. |
loadNewAccount | Add funds to a new payment account (such as a gift card) from an existing payment account. | Not supported. |
startPaymentAccountEnrollment | Initiate enrollment of a payment account that may be one or more steps. | Use B2B API startPaymentAccountEnrollment. |
continuePaymentAccountEnrollment | Continue the next step of a payment account enrollment that returned MORE_INFO status in the preceding step. | Use B2B API continuePaymentAccountEnrollment. |
retrieveIncompletePaymentAccountEnrollments | Get the list of enrollments that were initiated, but not completed. | Use B2B API retrieveIncompletePaymentAccountEnrollments. |
cancelPaymentAccountEnrollment | Cancel an incomplete enrollment. | Use B2B API cancelPaymentAccountEnrollment. |
verifyAccount | Verify ownership of a linked account by double-deposit matching. | Use B2B API submitAVSVerification. |
updateExistingPaymentAccount | Edit the values of a payment account record in the WLW platform. | Use B2B API updateCustomerCardInfo. |
loadExistingAccount | Add funds to a payment account in the wallet (such as a gift card) from an existing payment account in the wallet. | Not supported. |
deletePaymentAccount | Remove a payment account as a payment source int he wallet. | Use B2B API deleteCustomerCardInfo. |
retrieveSupportedTenderTypes | Get the set of tenders configured for use as payment accounts in the wallet, such as PayPal, and the metadata required when enrolling each tender in a wallet. | Use B2B API retrieveSupportedTenderTypes. |
retrieveSpecificSupportedTenderType | Get the metadata required to enroll a particular tender in the wallet. | Use B2B API retrieveSupportedTenderTypes with tender identifiers in the request to filter results. |
Preferences
The SDKs provided methods to retrieve a customer's customized app settings, such as whether to play sounds, default payment accounts, etc. These operations are no longer managed within the PayPal WLW platform and any customer options built into the merchant app are managed solely by the merchant in the server-side implementation.
Push Notifications
The SDKs provided methods to register a customer's consent to receive push notification messages from the app. These operations are no longer managed within the PayPal WLW platform and should be handled solely by the merchant in the server-side implementation.
Receipt Management
| SDK Method | Purpose | Guidance |
|---|---|---|
retrieveReceiptSummary | Get a set of abstracted receipt data for the purpose of showing a list to the user. | Not supported. |
retrieveReceiptDetail | Get full receipt data for a specified transaction. | Use B2B API retrieveUserReceiptByPaydiantRefId. |
retrieveReceiptsWithSplitTenderPayments | Get a set of receipts for transactions where multiple payment accounts were used to complete the payment. | Use B2B API retrievePaginatedUserReceipts. Multiple filtering criteria is supported. |
retrieveReceiptWithSplitTenderPayments | Get a specific receipt in which multiple payment accounts were used to complete the payment. | Use B2B API retrieveUserReceiptByPaydiantRefId. |
retrieveRefundableReceiptsWithSplitTenderPayments | Get the current balance of a payment account in the wallet. | Use B2B API retrievePaginatedUserReceipts. Multiple filtering criteria is supported. |
User Registration
| SDK Method | Purpose | Guidance |
|---|---|---|
retrieveMfaQuestionsWithMetadata | Get the set of merchant-defined questions available for multi-factor authentication that the user can set during registration. | Defined by merchant IDP solution. |
retrievePasswordConfigurations | Get the merchant defined minimum requirements for a user password. | Defined by merchant IDP solution. |
retrievePasscodeConfigurations | Get the merchant-defined minimum requirements for a user PIN. | Defined by merchant IDP solution. |
registerNewUser | Register a user on the PayPal WLW platform. | Use B2B API createCustomer. |
registerCustomer | Register a user on the PayPal WLW platform whose authentication credentials are managed by an 3rd party IDP. | Not supported. |
retrieveCustomerProfileMetadata | Get profile property values from an external IDP using an authorization token. | Not supported. |
resendVerificationEmail | Trigger an email to the user containing a link to a secure multi-factor authentication portal that verifies the user's access to the email address provided during registration. | Merchant discretion. |
updateUserProfile | Submit changes to previously set user profile property values. | Use B2B API updateCustomer. |
updateUserPassword | Reset a user's login password with a new value input by the user. | Merchant discretion. |
updateUserPasscode | Reset a user's login PIN with a new value input by the user. | Merchant discretion. |
updateMFAAnswers | Reset a user's secret question responses a new set of questions/answers input by the user. | Merchant discretion. |
changeExpiredPassword | Reset a user's expired login password with a new value input by the user. | Merchant discretion. |
resetForgottenPassword | Trigger an email containing a link to a secure portal through which the user can verify their identity and reset their login password. | Merchant discretion. |
resetForgottenPasscode | Trigger an email containing a link to a secure portal through which the user can verify their identity and reset their login PIN. | Merchant discretion. |
Transaction Management
| SDK Method | Purpose | Guidance |
|---|---|---|
obtainCheckoutTokenFor | Get a checkout token that can be rendered as a QR code on the mobile device. | Use B2B API ObtainMobileDeviceCheckoutToken. |
releaseCheckoutToken | Cancel a generated token that has not been scanned. | Use B2B API ReleaseMobileDeviceCheckoutToken. |
retrieveTransactionMetadata | Get data from the WLW platform that is relevant for the current step of the transaction. | Use B2B API RetrieveMobileTransactionMetadata or RetrieveMobileTransactionMetadata Webhook. |
updateTransaction | Submit data to the WLW platform that is relevant to the current step of the transaction. | Use B2B API UpdateMobileTransaction. |
generateAccessCode | Generate a random code for use as a secondary identifier for pre-auth transactions. | Merchant discretion. |
cancelTransactionUsingToken | Issue a device-initiated cancelation of a transaction. | Use B2B API CancelMobileTransaction. |