{"id":16830,"date":"2015-01-22T22:14:32","date_gmt":"2015-01-22T16:44:32","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=16830"},"modified":"2016-12-19T14:54:49","modified_gmt":"2016-12-19T09:24:49","slug":"paypal-sdk-integration-in-android-applications","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/paypal-sdk-integration-in-android-applications\/","title":{"rendered":"PayPal SDK Integration in Android Applications"},"content":{"rendered":"

I recently had to integrate a PayPal payment mechanism in one of my Android applications<\/a>.<\/p>\n

So I thought to share my knowledge with the community that you can easily integrate payment mechanism in your application.<\/p>\n

What is PayPal?<\/strong><\/h3>\n

Established in 1998, PayPal is an American company allowing payments and money transfers to be made through the internet. PayPal is one of the world’s largest internet payment companies. The company performing payment processing for online vendors, auction sites and other commercial users. It supports 26 currencies across 193 nations.<\/p>\n

PayPal Android SDK:<\/strong><\/h3>\n

PayPal provides its Android SDK to incorporate in-app payment mechanism for any service user avails or any purchase the user do using your application. The Android SDK makes it easy to add PayPal or Credit Card payments to mobile applications. The payments will directly be credited to registered account on PayPal.<\/p>\n

Steps to integrate it in your\u00a0Android application:<\/strong><\/h3>\n

Step 1.\u00a0<\/strong><\/p>\n

Go to PayPal developer website<\/a>\u00a0and create a PayPal account by signing up.<\/p>\n

\"Screen<\/a><\/p>\n

After clicking “Sign Up” button, the registration form will open. Fill up the registration form. Note it takes only five digit zip code and probably only USA addresses. When you enter a valid zip code of USA, it automatically fills up the country code and city name fields.<\/p>\n

\"reg_partially_filled\"<\/a><\/p>\n

After creating a PayPal account, \u00a0sign in into PayPal developer website\u00a0by clicking “Sign In” button on the top right corner. \u00a0After Sign In, go to “Dashboard” tab and click “Create App” button to create an application.<\/p>\n

\"create_app_page\"<\/a><\/p>\n

Fill up the create app form and click “Create App” button. It will create your application and by default it also creates a Sandbox developer account for you and this default account can not be edited, however you can create new accounts for testing your application. This account will be used to test your application during development phase. Since it is used for testing, it is called a sandbox developer account. This account later can be upgraded to production account for live application.<\/p>\n

\"createapp_form\"<\/a><\/p>\n

When you will press “Create app” button you will get an application created for you with “Client Id” and a “Secret” key. “Client Id” will be used by your Android application<\/a> to perform transaction and “Secret” key will be used to verify a transaction, or getting user permission for direct future transactions or getting permission from user to get user profile data from user’s PayPal account such as date of birth, email address etc.<\/p>\n

You can see your all applications \u00a0under “My apps” tab.<\/p>\n

\"carrentalapp\"<\/a><\/p>\n

Step 2.<\/strong><\/p>\n

Download PayPal Android SDK form Github<\/a>.<\/p>\n

Unzip PayPal-Android-SDK-master.zip file and from\u00a0the lib folder copy all the contents and paste it in your Android project’s lib folder. Note if you don’t have a lib folder already in your project create one and if you already have lib folder in your project just paste the SDK’s lib folder’s contents in it. If you already have “armeabi” and other such\u00a0folders in your project’s lib folder, then manually copy paste the contents of the these folders in your projects respective folders inside the lib folder.<\/p>\n

The SDK also has a sample Android application to understand the code implementation. Run the application and see its flow and try to understand its \u00a0code. It has proper\u00a0description in the form of comments to understand it easily.<\/p>\n

Now open the Android.manifest file of your Android project and declare the following attributes in it:<\/p>\n

<!\u2013 for card.io card scanning \u2013> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <uses-permissionandroid:name=\u201candroid.permission.CAMERA\u201d \/> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <uses-permissionandroid:name=\u201candroid.permission.VIBRATE\u201d \/><\/p>\n

<uses-featureandroid:name=\u201candroid.hardware.camera\u201d android:required=\u201cfalse\/>
\n<uses-featureandroid:name=\u201candroid.hardware.camera.autofocus\u201d\u00a0android:required=\u201cfalse\u201d \/><\/p>\n

<!\u2013 for most things, including card.io & paypal \u2013> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <uses-permissionandroid:name=\u201candroid.permission.ACCESS_NETWORK_STATE\u201d\/> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <uses-permissionandroid:name=\u201candroid.permission.INTERNET\u201d\/><\/p>\n

Step 3.<\/strong><\/p>\n

There are three use cases of this SDK.<\/p>\n

1. Single Payment \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 2. Future Payment \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a03. Profile Sharing<\/p>\n

1. Single Payment:<\/strong><\/p>\n

Receive a single immediate payment from your application either via PayPal account or via Debit or Credit Card.<\/p>\n

When you initiate a single payment, the SDK presents a UI to gather user PayPal account or Credit or Debit card info \u00a0and perform transaction and returns a proof of payment with payment id using which user can verify the payment transaction. For payment verification PayPal provides web apis which can be used by setting up our own server for verification.<\/p>\n

\"paypal_paymentui\"<\/a><\/p>\n

User can make payment either using PayPal account or using credit or debit card.<\/p>\n

Inside the activity:<\/strong><\/p>\n

1. Create a PayPalConfigration<\/em><\/span> Object :<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\nprivate static PayPalConfiguration config = new PayPalConfiguration()<\/p>\n

\/\/ Start with mock environment. When ready, switch to sandbox (ENVIRONMENT_SANDBOX)
\n \/\/ or live (ENVIRONMENT_PRODUCTION)
\n .environment(PayPalConfiguration.ENVIRONMENT_NO_NETWORK)<\/p>\n

.clientId("<YOUR_CLIENT_ID>");
\n[\/sourcecode]<\/p>\n

2. Start PayPalService<\/span><\/em><\/span> when your activity is created and stop it upon destruction:<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\n@Override
\nprotected void onCreate(Bundle savedInstanceState) {
\n super.onCreate(savedInstanceState);
\n setContentView(R.layout.activity_main);<\/p>\n

Intent intent = new Intent(this, PayPalService.class);<\/p>\n

intent.putExtra(PayPalService.EXTRA_PAYPAL_CONFIGURATION, config);<\/p>\n

startService(intent);
\n}<\/p>\n

@Override
\npublic void onDestroy() {
\n stopService(new Intent(this, PayPalService.class));
\n super.onDestroy();
\n}
\n[\/sourcecode]<\/p>\n

3. Create the PayPalPayment<\/span><\/em> object and launch the PaymentActivity<\/span><\/em> intent, for example, when a button is pressed:<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\npublic void onBuyPressed(View pressed) {<\/p>\n

\/\/ PAYMENT_INTENT_SALE will cause the payment to complete immediately.
\n \/\/ Change PAYMENT_INTENT_SALE to
\n \/\/ – PAYMENT_INTENT_AUTHORIZE to only authorize payment and capture funds later.
\n \/\/ – PAYMENT_INTENT_ORDER to create a payment for authorization and capture
\n \/\/ later via calls from your server.<\/p>\n

PayPalPayment payment = new PayPalPayment(new BigDecimal("1.75"), "USD", "hipster jeans",
\n PayPalPayment.PAYMENT_INTENT_SALE);<\/p>\n

Intent intent = new Intent(this, PaymentActivity.class);<\/p>\n

\/\/ send the same configuration for restart resiliency
\n intent.putExtra(PayPalService.EXTRA_PAYPAL_CONFIGURATION, config);<\/p>\n

intent.putExtra(PaymentActivity.EXTRA_PAYMENT, payment);<\/p>\n

startActivityForResult(intent, 0);
\n}
\n[\/sourcecode]<\/p>\n

4. Implement onActivityResult()<\/em><\/span>:<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\n@Override
\nprotected void onActivityResult (int requestCode, int resultCode, Intent data) {
\n if (resultCode == Activity.RESULT_OK) {
\n PaymentConfirmation confirm = data.getParcelableExtra(PaymentActivity.EXTRA_RESULT_CONFIRMATION);
\n if (confirm != null) {
\n try {
\n Log.i("paymentExample", confirm.toJSONObject().toString(4));<\/p>\n

\/\/ TODO: send ‘confirm’ to your server for verification.
\n \/\/ see https:\/\/developer.paypal.com\/webapps\/developer\/docs\/integration\/mobile\/verify-mobile-payment\/
\n \/\/ for more details.<\/p>\n

} catch (JSONException e) {
\n Log.e("paymentExample", "an extremely unlikely failure occurred: ", e);
\n }
\n }
\n }
\n else if (resultCode == Activity.RESULT_CANCELED) {
\n Log.i("paymentExample", "The user canceled.");
\n }
\n else if (resultCode == PaymentActivity.RESULT_EXTRAS_INVALID) {
\n Log.i("paymentExample", "An invalid Payment or PayPalConfiguration was submitted. Please see the docs.");
\n }
\n}
\n[\/sourcecode]<\/p>\n

5. Send the proof of payment to your servers for verification<\/a>, as well as any other processing required for your business fulfilment.<\/p>\n

Tip: At this point, the payment has been completed, and the user has been charged. If you can’t reach your server, it is important that you save the proof of payment and try again later.<\/p>\n

2. Future Payments:<\/strong><\/p>\n

This section will show how to obtain a user’s authorized consent for future payments using their PayPal account.<\/p>\n

First, you must obtain customer’s consent<\/a> to take payments from their PayPal account. PayPal Android SDK presents a UI for your user to authenticate using their PayPal account and asks user to consent to OAuth access token scope<\/a> to use PayPal for future payments.<\/p>\n

\"future_consent\"<\/a><\/p>\n

It returns an OAuth2 authorization code to your app. Send the authorisation code to your server, which then exchanges the code for OAuth2 access and refresh tokens<\/a>.<\/p>\n

Later, when initiating a pre-consented payment, you must obtain a Client Metadata ID<\/a>.\u00a0The PayPal Android SDK provides a Cient Metadata ID. Sends the client metadata ID and transaction information to your server.\u00a0Your server then uses its OAuth2 tokens, Client Metadata ID, and transaction info to create a payment<\/a>.<\/p>\n

Inside your Activity code:<\/strong><\/p>\n

1.\u00a0Create a PayPalConfiguration<\/code><\/em> object. This object allows you to configure various aspects of the SDK.<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\nprivate static PayPalConfiguration config = new PayPalConfiguration()<\/p>\n

\/\/ Start with mock environment. When ready, switch to sandbox (ENVIRONMENT_SANDBOX)
\n \/\/ or live (ENVIRONMENT_PRODUCTION)
\n .environment(PayPalConfiguration.ENVIRONMENT_NO_NETWORK)<\/p>\n

.clientId("<YOUR_CLIENT_ID>")<\/p>\n

\/\/ Minimally, you will need to set three merchant information properties.
\n \/\/ These should be the same values that you provided to PayPal when you registered your app.
\n .merchantName("Hipster Store")
\n .merchantPrivacyPolicyUri(Uri.parse("https:\/\/www.example.com\/privacy"))
\n .merchantUserAgreementUri(Uri.parse("https:\/\/www.example.com\/legal"));<\/p>\n

[\/sourcecode]<\/p>\n

2. Start PayPalService<\/em><\/span> when your activity is created and stop it upon destruction:<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\n@Override
\nprotected void onCreate(Bundle savedInstanceState) {
\n super.onCreate(savedInstanceState);
\n setContentView(R.layout.activity_main);<\/p>\n

Intent intent = new Intent(this, PayPalService.class);<\/p>\n

intent.putExtra(PayPalService.EXTRA_PAYPAL_CONFIGURATION, config);<\/p>\n

startService(intent);
\n}<\/p>\n

@Override
\npublic void onDestroy() {
\n stopService(new Intent(this, PayPalService.class));
\n super.onDestroy();
\n}
\n[\/sourcecode]<\/p>\n

3. Launch the PayPalFuturePaymentActivity<\/span>, for example, when a button is pressed:<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\npublic void onFuturePaymentPressed(View pressed) {
\n Intent intent = new Intent(SampleActivity.this, PayPalFuturePaymentActivity.class);<\/p>\n

\/\/ send the same configuration for restart resiliency
\n intent.putExtra(PayPalService.EXTRA_PAYPAL_CONFIGURATION, config);<\/p>\n

startActivityForResult(intent, REQUEST_CODE_FUTURE_PAYMENT);
\n}
\n[\/sourcecode]<\/p>\n

4. Implement onActivityResult()<\/span><\/em>:<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\n@Override
\nprotected void onActivityResult (int requestCode, int resultCode, Intent data) {
\n if (resultCode == Activity.RESULT_OK) {
\n PayPalAuthorization auth = data
\n .getParcelableExtra(PayPalFuturePaymentActivity.EXTRA_RESULT_AUTHORIZATION);
\n if (auth != null) {
\n try {
\n String authorization_code = auth.getAuthorizationCode();<\/p>\n

sendAuthorizationToServer(auth);<\/p>\n

} catch (JSONException e) {
\n Log.e("FuturePaymentExample", "an extremely unlikely failure occurred: ", e);
\n }
\n }
\n } else if (resultCode == Activity.RESULT_CANCELED) {
\n Log.i("FuturePaymentExample", "The user canceled.");
\n } else if (resultCode == PayPalFuturePaymentActivity.RESULT_EXTRAS_INVALID) {
\n Log.i("FuturePaymentExample",
\n "Probably the attempt to previously start the PayPalService had an invalid PayPalConfiguration. Please see the docs.");
\n }
\n}
\n[\/sourcecode]<\/p>\n

5. Send the authorization response to your server in order to complete the process.<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\nprivate void sendAuthorizationToServer(PayPalAuthorization authorization) {<\/p>\n

\/\/ TODO:
\n \/\/ Send the authorization response to your server, where it can exchange the authorization code
\n \/\/ for OAuth access and refresh tokens.
\n \/\/
\n \/\/ Your server must then store these tokens, so that your server code can execute payments
\n \/\/ for this user in the future.<\/p>\n

}
\n[\/sourcecode]<\/p>\n

6. Obtain a Client Metadata ID:<\/p>\n

When initiating a pre-consented payment (a “future payment”) from a mobile device, your mobile application must obtain a Client Metadata Id from the Mobile SDK to pass to your server. Your server must include this Client Metadata ID in its payment request sent to PayPal. PayPal uses this Client Metadata ID to verify that the payment is originating from a valid, user-consented device+application.<\/p>\n

Example:<\/p>\n

[sourcecode language=”java” wraplines=”false” collapse=”false”]
\npublic void onFuturePaymentPurchasePressed(View pressed) {
\n\/\/ Get the Client Metadata ID from the SDK
\nString metadataId = PayPalConfiguration.getClientMetadataId(this);<\/p>\n

\/\/ TODO: Send metadataId and transaction details to your server for processing with
\n\/\/ PayPal…
\n}
\n[\/sourcecode]<\/p>\n

When your server makes its payment request to PayPal, it must include a PayPal-Client-Metadata-Id HTTP header with this Client Metadata ID value obtained from the SDK.<\/p>\n

Future Payments Server-Side Integration:<\/strong><\/p>\n

Once a user has authorized your app to use their PayPal account, you can then use that authorization to obtain tokens that let you create future payments from that user.<\/p>\n

Read Future Payments Server-Side Integration<\/a> to exchange the authorization code for OAuth2 tokens and create payments with an access token and a Metadata ID.<\/p>\n

3. Profile Sharing:<\/strong><\/h3>\n

This section will show how to obtain a user’s authorized consent for profile sharing from their PayPal account.<\/p>\n

Your customer logs in to PayPal and consents to PayPal sharing information with you:<\/p>\n

\"profile_sharing_user_consent\"<\/a><\/p>\n

 <\/p>\n

You must obtain customer consent<\/a> to share information from their PayPal account.<\/p>\n

How this works:<\/p>\n