Install the SDK

Add the SDK package

12345

# With yarnyarn add @primer-io/react-native
# With npmnpm i @primer-io/react-native --save

Requirement for iOS

Once you are done, navigate to the /ios folder and run pod install.

Step 1. Prepare Headless Universal Checkout

Firstly, import HeadlessUniversalCheckout from @primer-io/react-native. Then set Headless Universal Checkout callbacks in the headlessUniversalCheckoutCallbacks property of your settings. These callbacks are handled during the checkout’s lifecycle.

Once done, start HeadlessUniversalCheckout with your session’s client token. This will return a list of available payment methods for you to handle.

1234567891011121314151617181920212223242526272829

import { useEffect } from 'react'import { HeadlessUniversalCheckout, PrimerSettings, PrimerCheckoutData } from '@primer-io/react-native'
export const CheckoutScreen = () => {    const [paymentMethods, setPaymentMethods] = useState(null)
    useEffect(() => {        const initHeadlessUniversalCheckout = async () => {            const settings: PrimerSettings = {                //...                headlessUniversalCheckoutCallbacks: {                    onCheckoutComplete = (checkoutData: PrimerCheckoutData) => {                        // Here you will receive the checkout data of the payment.                    },                    onAvailablePaymentMethodsLoad = (paymentMethodTypes: string[]) => {                        // paymentMethodTypes contains the payment methods identifiers available                        // for the client session.                    },                },            }
            // 👇 Call this function to start Headless Universal Checkout and retrieve the list of available payment methods            const availablePaymentMethods = await HeadlessUniversalCheckout.startWithClientToken(clientToken, settings)            setPaymentMethods(availablePaymentMethods)        }
        initHeadlessUniversalCheckout()    }, [clientToken])}

Each payment method returned contains the following:

• paymentMethodType
  a unique string identifier for the payment method (e.g. ADYEN_IDEAL)
• paymentMethodName
  a user friendly English localized string identifier for the payment method (e.g. Apple Pay)
• supportedPrimerSessionIntents
  an array of SessionIntent which defines what intents can be used with this payment method (i.e. CHECKOUT or VAULT).
• paymentMethodManagerCategories
  an array which defines the payment method managers that can be used with this payment method (i.e. NATIVE_UI or RAW_DATA).
• [Optional] requiredInputDataClass
  the String representing class type that should be used with the raw data manager.

Step 2: Render available payment methods UI

You should now have the available payment methods for the client session. You can render your own UI for each payment method, or take advantage of the AssetsManager helper to get access to payment methods' resources.

123456789101112131415161718192021

import { AssetsManager, Asset } from '@primer-io/react-native'
const getPaymentMethodResources = async () => {    const assetsManager = new AssetsManager()    const resources: Resource[] = await assetsManager.getPaymentMethodResources()    return resources}

const resources = getPaymentMethodResources();const isNativeView = typeof paymentMethodResource.nativeViewName === "string";if (isNativeView) {    // paymentMethodResource is of type NativeViewResource    <NativeResourceView        onPress={() => { /* Handle press */ }}        nativeViewName={paymentMethodResource.nativeViewName!}    />} else {    // paymentMethodResource is of type AssetResource    // Render your own UI using colors from the asset object}

AssetResource

The payment method asset contains the following:

• paymentMethodType
  a unique string identifier for the payment method.
• paymentMethodName
  a user friendly English localized string identifier for the payment method (e.g. Apple Pay)
• paymentMethodLogo
  contains the logos’ local URLs
  • colored?: string: Local URL for the colored value of the logo
  • dark?: string: Local URL for the dark value of the logo
  • light?: string: Local URL for the light value of the logo
• paymentMethodBackgroundColor
  contains the background colors hex values
  • colored?: string: Color hex value for the colored background color
  • dark?: string: Color hex value for the dark mode background color
  • light?: string: Color hex value for the light mode background color

NativeViewResource

• paymentMethodType
  a unique string identifier for the payment method.
• paymentMethodName
  a user friendly English localized string identifier for the payment method (e.g. Apple Pay)
• nativeViewName
  a string representing the name of the native view. Pass this when rendering NativeResourceView.

The payment method native view resource contains the following:

Using the provided payment method views is required for certain payment methods, such as Google Pay. The Primer SDK ensures these views are seamlessly integrated and configured based on the PrimerSettings and your client session details, where applicable.

With the above URLs and colors you can build your own payment method UI 💪.

Step 3: Implement a payment method manager

Now that your UI presents the available payment methods, let's use the payment method managers to allow users to go through the payment method flow.

A payment method manager is a class abstracting the state and UI of a given payment method. Currently, there are 3 payment methods managers, each of them responsible for a different payment method category.

• PrimerHeadlessUniversalCheckout.NativeUIManager
  The native UI manager is responsible for all payment methods that need to present their own UI (e.g. Apple Pay or Google Pay).
• PrimerHeadlessUniversalCheckout.RawDataManager
  The raw data manager is responsible for each payment method that you need to pass some raw data (e.g. card form).

Native UI manager

This manager can be used for any payment method that contains NATIVE_UI in the paymentMethodManagerCategories array.

The native UI manager can be used for any payment method that needs to present its own UI, like Apple Pay.

1234567

import { NativeUIManager } from '@primer-io/react-native'
const payWithPaymentMethod = async (paymentMethodType: string) => {    const nativeUIManager = new NativeUIManager()    await nativeUIManager.configure({ paymentMethodType: paymentMethod.paymentMethodType })    await nativeUIManager.showPaymentMethod(SessionIntent.CHECKOUT)}

That’s it! The SDK will present the native UI to the user, and then attempt to create a payment.

The payment’s data will be returned on the onCheckoutComplete that we configured in Step 1.

Raw Data Manager

This manager can be used for any payment method that contains RAW_DATA in the paymentMethodManagerCategories array.

The raw data manager can be used for payment methods that allow you to pass the data in the SDK (an example would be card data).

With the raw manager, you can use your fully customized UI and still use all of the features that make Primer great.

At any point, you can validate your data by calling setRawData() and by listening to onValidation. Primer will return errors specific to each required input.

When the data is valid, you can send it to Primer for further processing by calling submit().

Configure the RawDataManager

Assuming that the payment method contains RAW_DATA in the paymentMethodManagerCategories, create your raw data manager, and optionally set its delegate.

123456789101112

const initialize = async (paymentMethod: PaymentMethod) => {    // 👇 Initialize the raw data manager    await rawDataManager.configure({        paymentMethodType: paymentMethod.paymentMethodType,        onMetadataChange: data => {            // For example card number detected to be Visa        },        onValidation: (isValid, errors) => {            // Show on your UI if the card data aren't valid        },    })}

Build a form

Build your own form to let the users enter their data. You can use the getRequiredInputElementTypes() object to get informed about what input fields you have to render. It returns an array that can contain any of the following:

• "CARD_NUMBER",
• "EXPIRY_DATE",
• "CVV",
• "CARDHOLDER_NAME",
• "PHONE_NUMBER"

1234567

const initialize = async () => {    // ...    // Once done, get the required input elements types.
    // 👇 Get the required input element types, which will enable you to build your form    const requiredInputElementTypes = await rawDataManager.getRequiredInputElementTypes()}

Build and validate your rawData

Then use the class type that has been provided in the requiredInputDataClass in the payment method to build your raw data. Let’s say that you’re building card data, then you would do the following:

12345678910

// 👇 Create your raw dataconst rawCardData: CardData = {    cardNumber: cardNumber,    expiryDate: expiryDate, // 👈 ex. 03/2030    cvv: cvv,    cardholderName: cardholderName,}
// 👇 Set your raw data on the managerawait rawDataManager.setRawData(rawCardData)

Each time you set the data on the raw data manager, the manager will validate them and notify you via the callback onValidation. You can then change the state of your submit button based on the validation changes.

Submit the form's data

Once the data has been validated, call the manager's submit() function.

1234

const handleSubmit = async () => {    // 👇 Submit the data that have been set in prior steps    await rawDataManager.submit()}

That’s it! When the function submit() is called, the SDK will attempt to create a payment.

The payment’s data will be returned on the onCheckoutComplete configured in Step 1.

Handle errors

Use the onError callback of the HeadlessUniversalCheckout options to handle any errors emitted by the SDK during the checkout flow.

1234567

const onError = (    error: PrimerError,    checkoutData: PrimerCheckoutData | null,    handler: PrimerErrorHandler | undefined,) => {    // Handle the error}

Advanced Configuration

For more customization on your needs, you can listen to all events posted by Headless Universal Checkout and react to them. Visit the API reference for a full list of the listener functions.

Prepare 3DS

• In order to make the SDK lightweight, 3DS requires the addition of the Primer 3DS library. Check out our guide on how to add the Primer 3DS library to your iOS app.
• When the user pays by card, the Workflow will decide whether or not a 3DS challenge is required. If so, Headless Universal Checkout will automatically render the 3DS challenge.
• To improve 3DS success rates, it is recommended to pass the following elements in the Client Session:

Learn more about how to configure 3DS!

Did It Work?

If everything went well, you should be able to see the payment you just created on your Dashboard under the Payments menu.