TypeScript icon, indicating that this package has built-in type declarations

4.1.2 • Public • Published


npm version npm GitHub license

React Native library that implements PayPal Checkout flow using purely native code.


Getting started

$ npm install react-native-paypal --save or $ yarn add react-native-paypal

Mostly automatic installation

  1. $ react-native link react-native-paypal. Check the result, if iOS and/or Android project files are unchanged, do the steps described in Manual installation.
  2. [Android] Add implementation "com.braintreepayments.api:braintree:3.+" and implementation "com.braintreepayments.api:data-collector:3.+" in android/app/build.gradle.
  3. [iOS] Add pod 'Braintree', '~> 4' and pod 'Braintree/DataCollector' to your Podfile.
  4. [iOS] Run pod install
  5. [iOS] Register a URL scheme in Xcode (must always start with your Bundle Identifier and end in .payments - e.g. See details here.
  6. [iOS] Edit your AppDelegate.m as follows:
    #import "RNPaypal.h"
    - (BOOL)application:(UIApplication *)application 
      didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
      [[RNPaypal sharedInstance] configure];
    // if you support only iOS 9+, add the following method
    - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url
      options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
      return [[RNPaypal sharedInstance] application:application openURL:url options:options];
    // otherwise, if you support iOS 8, add the following method
    - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url
      sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
      return [[RNPaypal sharedInstance] application:application openURL:url sourceApplication:sourceApplication annotation:annotation];

At this point you should be able to build both Android and iOS.

Extra setup step

If your application ID has underscores in it (e.g. com.example_app), an additional setup step is required. Otherwise, you can skip this section.

Inside ApplicationManifest.xml add a BraintreeBrowserSwitchActivity. Specify the android:scheme to be your application id without underscores and .braintree appended to it:

<activity android:name="com.braintreepayments.api.BraintreeBrowserSwitchActivity"
      <action android:name="android.intent.action.VIEW" />
      <category android:name="android.intent.category.DEFAULT" />
      <category android:name="android.intent.category.BROWSABLE" />
      <data android:scheme="com.exampleapp.braintree" />

Manual installation


  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-paypal and add RNPaypal.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNPaypal.a to your project's Build PhasesLink Binary With Libraries
  4. In XCode, in the project navigator, select your project. Add $(SRCROOT)/../node_modules/react-native-paypal/ios to your project's Build SettingsHeader Search Paths


  1. Open up android/app/src/main/java/[...]/
  • Add import com.smarkets.paypal.RNPaypalPackage; to the imports at the top of the file
  • Add new RNPaypalPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-paypal'
    project(':react-native-paypal').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-paypal/android')
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      implementation project(':react-native-paypal')


First you need to get a valid token from your server. Refer to this.

Then you can execute the following code, for example reacting to a button press.

import { requestOneTimePayment, requestBillingAgreement } from 'react-native-paypal'; 

// For one time payments
const {
} = await requestOneTimePayment(
    amount: '5', // required
    // any PayPal supported currency (see here:
    currency: 'GBP',
    // any PayPal supported locale (see here:
    localeCode: 'en_GB', 
    shippingAddressRequired: false,
    userAction: 'commit', // display 'Pay Now' on the PayPal review page
    // one of 'authorize', 'sale', 'order'. defaults to 'authorize'. see details here:
    intent: 'authorize', 

// For vaulting paypal account see:
const {
} = await requestBillingAgreement(
    billingAgreementDescription: 'Your agreement description', // required
    // any PayPal supported currency (see here:
    currency: 'GBP',
    // any PayPal supported locale (see here:
    localeCode: 'en_GB',

// For device data collection see:
const { deviceData } = await requestDeviceData(token);

Creating/Finding client token

Note that the client token should be served via a backend service but can be hardcoded:

  1. Go to or and login or create an account
  2. Click the gear at the top and select to API
  3. You can find your token under Tokenization Keys. You will need to create one if none exists

Backend implementation

For an overview of the braintree payment flow see

This library covers the client setup here:

It does NOT however cover the server portion here:

You will need the server portion in order to complete your transactions. See a simple example of this server in /exampleServer. The example app is pointed to this on default


  • Check native code logs (in xCode for iOS or adb logcat *:E for Android). These may give additional information about issues
  • Try comparing your app implementation to the example app. It may help you find a step you missed. If you experience any issues with the example app or instructions missing from the Readme, please open an issue (or fix with a PR :))


npm i react-native-paypal-vtbl

DownloadsWeekly Downloads






Unpacked Size

305 kB

Total Files


Last publish


  • cdgmx