Enroll a PayPal payment account in an existing wallet

DOCS

Last updated: Aug 15th, 6:18am

Allow users who already have a registered mobile wallet to add PayPal as a valid payment tender in that wallet.

Figure 3: Payment account enrollment screen flow

As shown in Figure 3, the app provides an operator specific to the PayPal account type. When selected, call the PayPal Braintree SDK client and invoke the app switch; the Braintree SDK client checks whether the One-Touch client is installed on the device, and displays the PayPal login and consent screens in the app or in a browser, accordingly. In either case, once the user consents to the integration, the Braintree SDK client returns the BTPaymentAccountNonce and switches the focus back to the mobile wallet app.

Figure 4 shows the data process flow involved in the assisted registration.

Figure 4: PayPal account enrollment sequence diagram

The next sections provide implementation and samples for each of the relevant calls depicted in Figure 4.

Start enrollment

Use these commands to begin enrollment and implement the success and failure responses.

Invoke the specific WLW SDK call to start payment account enrollment for your device.

OS	Command
iOS	`startPaymentAccountEnrollment:(PDStartPaymentAccountEnrollmentRequest *)request;`
Android	`startPaymentAccountEnrollment (StartPaymentAccountEnrollment startPaymentAccountEnrollment);`

Within each of the parameter objects, the following data must be passed:

iOS Property	Description
`enrollmentType`	Required Enum A value specifying whether WLW will be the system of record for the payment account. For this use case, the only supported value is `kPDEnrollmentTypeProvision`
`paymentAccountTypeUri`	Required String WLW’s unique identifier for the type of payment account.
`paymentAccountNetworkTypeUri`	Required String WLW’s unique identifier for the payment processor.
`additionalData`	Required Array A set of property instances that define other data required for the enrollment. For this use case, you must define the following: key = `NICKNAME` value = `PayPal`

Implement the device OS-specific WLW SDK callback to handle the success response.

OS	Command
iOS	`startPaymentAccountEnrollmentCompletionBlock:(PDStartPaymentAccountEnrollmentResponse *)response`
Android	`onStartPaymentAccountEnrollmentSuccess (PaymentAccountEnrollment paymentAccountEnrollment)`

Within either respective parameter object, the following data may be returned:

Property	Description
`enrollmentState`	Enum An EnrollmentState enum value indicating whether the enrollment process is complete or requires another step. For this step in the implementation, the value for this parameter will be `MORE_INFO`.
`paydiantCorrelationId`	String WLW’s unique identifier for the enrollment process. Required for each step in the enrollment to correctly associate all related data.
`externalCorrelationId`	String PayPal’s unique identifier for the enrollment; required for all related enrollment calls to ensure accurate processing and logging.
`additionalEnrollmentData`	Array/List The set of key/value definitions representing properties relevant for the enrollment. For this step in the implementation, PayPal returns the `btClientToken` within this property.

Configure the success response to initialize Braintree SDK client using the returned token value.

Implement the device OS-specific WLW SDK callback to handle the failure response.

OS	Command
iOS	`startPaymentAccountEnrollmentFailureBlock:(PDPaydiantError *managePaymentInstrumentError);`
Android	`onStartPaymentAccountEnrollmentError (PaydiantException exception)`

Within each of the parameter objects, the following data may be returned:

Property	Description
`Description`	String The basic error description returned by the SDK.
`statusMessage`	String The Mobile Gateway description associated with the returned `statusCode`.
`statusCode`	Integer The code representing the failure reason from the Mobile Gateway.
`rawErrorDescription`	String An error description reported by the device operating system.
`localizedDescription`	String A custom message relevant to the error.
`errorInformation`	String An object containing error information as obtained from an external party, such as the response from a payment provider.

Samples

Sample Start PayPal Enrollment in Existing Wallet for iOS

1- (void)addPayPal:(PDTenderType *)tender {
2
3    PDStartPaymentAccountEnrollmentRequest * request = [[PDStartPaymentAccountEnrollmentRequest alloc] init];
4    request.enrollmentType = kPDEnrollmentTypeProvision;
5    request.paymentAccountTypeUri = tender.paymentAccountType.paymentAccountTypeUri;
6    request.paymentAccountNetworkTypeUri = tender.paymentAccountNetworkType.paymentAccountNetworkTypeUri;
7
8    NSMutableArray * additionalInfo = [[NSMutableArray alloc] init];
9
10    PDStartPaymentAccountEnrollmentAdditionalData * instances = PDStartPaymentAccountEnrollmentAdditionalData alloc] init];
11    instances.additionalDataKey = @"NICK_NAME";
12    instances.additionalDataValue = @"PayPal";
13    [additionalInfo addObject: instances];
14
15    request.additionalData = additionalInfo;
16
17    PDManagePaymentInstrumentsCoordinator * managePayInstr = [[PDManagePaymentInstrumentsCoordinator alloc] init];
18    [CommonUtil showProgressIndicatorOnView: self];
19    [managePayInstr startPaymentAccountEnrollment: request completionBlock: ^(PDStartPaymentAccountEnrollmentResponse * response) {
20        NSString *paydiantCorrelationId = response.paymentAccountEnrollment.paydiantCorrelationId;
21        NSString *externalCorrelationId = response.paymentAccountEnrollment.externalCorrelationId;
22        NSArray *additionalData = response.paymentAccountEnrollment.additionalEnrollmentData;
23
24        if (additionalData.count &lt;0) {
25            PDAdditionalEnrollmentData *pdData = additionalData[0];
26            NSString *btClientToken = pdData.additionalEnrollmentDataValue;
27            BTAPIClient *apiClient = [[BTAPIClient alloc] initWithAuthorization: btClientToken];
28            BTPayPalDriver *btPayPalDriver = [[BTPayPalDriver alloc] initWithAPIClient: apiClient];
29            btPayPalDriver.appSwitchDelegate = (id) self;
30            btPayPalDriver.viewControllerPresentingDelegate = (id) self;
31            BTPayPalRequest *checkout = [[BTPayPalRequest alloc] init];
32            [btPayPalDriver requestBillingAgreement: checkout completion: ^(BTPayPalAccountNonce * _Nullable tokenizedPayPalCheckout, NSError * _Nullable error) {
33                if (error) {
34                    NSLog(@"ERROR = %@", error);
35                    [CommonUtil hideProgressIndicatorOnView: self];
36                    [CommonUtil displayMessageWithTitle:@"Error"
37                            andDescription: @"Your PayPal account could not be linked at this time. Please try again."];
38                }
39                else if (tokenizedPayPalCheckout) {
40                    NSString * nonce = tokenizedPayPalCheckout.nonce;
41                    NSLog(@"Got a nonce: %@", nonce);
42                }
43            }
44        }
45    }
46}

Sample Start PayPal Enrollment in Existing Wallet for Android

1{
2  StartPaymentAccountEnrollment paymentAccountEnrollment = new StartPaymentAccountEnrollment();
3  List &lt;AdditionalData&gt; additionalDataList = new ArrayListAdditionalData();
4  AdditionalData nickNameAdditionalData = new AdditionalData();
5  nickNameAdditionalData.setKey(getString(R.string.additional_data_nickname_key));
6  nickNameAdditionalData.setValue(getString(R.string.additional_data_nickname_value));
7  additionalDataList.add(nickNameAdditionalData);
8  paymentAccountEnrollment.setAdditionalData(additionalDataList);
9  paymentAccountEnrollment.setEnrollmentType(EnrollmentType.PROVISION);
10  paymentAccountEnrollment.setPaymentAccountTypeUri(accountTypeURI);
11  paymentAccountEnrollment.setPaymentAccountNetworkTypeUri(accountNetworkTypeURI);
12  paymentAccountManagementService.startPaymentAccountEnrollment(paymentAccountEnrollment);
13  Log.d(ApplicationConstants.LOG_TAG, "startPaymentAccountEnrollment()");
14}

Initialize Braintree SDK client

See Initialize Braintree SDK client for samples and links to the Braintree documentation you can use to learn how to initialize the Braintree SDK client.

Continue enrollment

Once the Braintree SDK returns the payment account nonce, use these commands to continue the enrollment and set the success and failure responses.

OS	Command
iOS	`continuePaymentAccountEnrollment:(PDContinuePaymentAccountEnrollmentRequest *)request;`
Android	`continuePaymentAccountEnrollment (ContinuePaymentAccountEnrollment continuePaymentAccountEnrollment);`