Last Updated: 15 May 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.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

How does it work?

We are securing your customer's payment details by generating sessions. You can then create a token with the card details and optionally use the CVC to take a payment.

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.61.5
  • react version ≥ 16.9.0
  • 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

See our guides on how to create sessions you can use to take a payment:

Note

For one-time payments, you would need to delete the token after you take the payment.

Create a session to pay with a card

  1. Submit card details to create a session
  2. Create a verified token
  3. Take a payment with this token

Create sessions to pay with a card and CVC

  1. Submit card details and CVC to create two separate sessions
  2. Create a verified token with your CARD session
  3. Use your CVC session and verified token in our card/checkout payment instrument to take a payment using one of the following endpoints:

Create a session for CVC only and pay with a stored token

  1. Submit the CVC to create a session
  2. Use your cvc session and stored verified token in our card/checkout payment instrument to take a payment using one of the following endpoints: