Last Updated: 22 January 2024 | Change Log

React Native SDK

Create your own uniquely styled and branded checkout form by integrating our SDK into your native app.

Read more about the Checkout SDK and the supported payment journeys here.

How does it work?

We are securing your customer's payment details by creating a session. You can then either apply the session directly in the payments api or create a token for use with our modular APIs.

What is a session?

A session is a unique identifier for your customer's payment details, generated by the SDK.

Prerequisites

The React Native SDK is compatible with the following:

• react-native version ≥ 0.70.0
• react version ≥ 18.1
• For iOS dependencies, Cocoapods support only.

Get our SDK

1. Run the following command to install our SDK.

   1. npm
   2. yarn

   npm install @worldpay/access-worldpay-checkout-react-native-sdk
   

2. Add a dependency to the Android Bridge in the Android part of your application.

   a. Define in your android/build.gradle file a local maven Repo for the Android Bridge which is shipped with the SDK.

   gradle

   maven { url("$rootDir/../node_modules/@worldpay/access-worldpay-checkout-react-native-sdk/android/") }
   

   b. Add the Android Bridge dependency in your gradle configuration.

   gradle

   dependencies { 
      ...
      implementation "com.worldpay.access:access-checkout-react-native-sdk-android-bridge:+"
      ...
   }
   

   c. Add the AccessCheckoutReactPackage which contains the Android Bridge to the list of ReactPackage exposed by your ReactApplication.

   1. Java
   2. Kotlin

   ...
   import com.worldpay.access.checkout.reactnative.AccessCheckoutReactPackage;
   
   public class MainActivity extends ReactActivity {
     ...
   
     public static class MainApplication extends Application implements ReactApplication {
   
       private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
         @Override
         public boolean getUseDeveloperSupport() {
           ...
         }
   
         @Override
         protected List<ReactPackage> getPackages() {
           List<ReactPackage> packages = new PackageList(this).getPackages();
           ...
           packages.add(new AccessCheckoutReactPackage());
   
           return packages;
         }
   
         @Override
         protected String getJSMainModuleName() {
           ...
         }
       };
   
       @Override
       public ReactNativeHost getReactNativeHost() {
         return mReactNativeHost;
       }
   
       @Override
       public void onCreate() {
         ...
       }
     }
   }
   

3. Add a dependency to the iOS Bridge in the iOS part of your application.

   To add the iOS dependency into your application, define the dependencies in the Podfile.

   Cocoapods

   target 'my-app' do
     ...
     pod 'AccessCheckoutReactNativeSDKiOSBridge', :path => '../node_modules/@worldpay/access-worldpay-checkout-react-native-sdk/ios/'
   end
   

What to do next