React Native integration guide

To integrate the Payment SDK into your React Native application and make a payment, 4 steps are required :

• Add the the payment SDK to your application
• Initialize the SDK
• Make a payment
• Check the transaction status

On this page you can also find:

• See our integration example
• Customize the SDK
• Enable the card scan feature
• Enable NFC feature
• Limitations
• Using our sdk in an Expo React Native application

In order to optimize the efficiency of our support, our SDK can send Sentry messages to our servers when an unusual situation or problem occurs. In this case, no sensitive data is transferred nor any data from your application.

See our integration example

You'll find sample code for integrating our SDK into a React Native application in the Github repository

Add the the payment SDK to your application

To add the payment sdk to your native react application :

1. Add our [Native Module] dependency (https://www.npmjs.com/package/@lyracom/react-native-sdk-payment-module) to your package.json file.

{
  "dependencies": {
   	 "@lyracom/react-native-sdk-payment-module": "^1.0.0",
    },
}

2. Add a reference to pod-install in the development dependencies:

 "devDependencies": {
   "pod-install": "^0.1.0"
 },

3. Edit the Podfile in your iOS folder:

• Add use_frameworks! following the "require_relative" instructions.

• Disable Flipper: comment out the line :flipper_configuration => FlipperConfiguration.enabled.

• Set the following parameters to false: , :hermes_enabled => false, and :fabric_enabled => false.

4. Run yarn.

5. Run yarn pod-install --quiet.

Initialize the SDK

As mentioned in the chapter on how the solution works , it's necessary to initialize the SDK.

To do this, simply call the initialize method with the following parameters:

Example of a call:

            // Initialize Payment SDK
            initialize(
              config.publicKey,
              {
                cardScanningEnabled: true,
                apiServerName: "MY_API_SERVER_NAME",
              },
              async (result) => {
                // onError
                Alert.alert(result.error.errorMessage);
              }
            );

Possible keys for the options object are :

It should also be noted that the SDK does not allow multiple processes in parallel. During the processing of the first call, the other calls will be ignored.

Make a payment

Making a payment is a 2-step process: initializing the display of the payment form, and processing the payment itself.

Initialize the display of the payment form

When the user decides to pay, you must initialize the display of the payment form.

To do this, you need to call your merchant server, to verify the user's purchases there, and then generate a form identifier (called formToken) by calling the Web Service Charge/CreatePayment (again from your merchant server). In this request, you need to pass a formTokenVersion parameter that matches the result of the SDK's getFormTokenVersion method. The Web Service response or this form token should then be returned to your mobile application.

            const getProcessPaymentContext = async () => {
              var formTokenVersion = getFormTokenVersion();
              return fetch(config.merchantServerUrl + "/createPayment", {
                method: "POST",
                headers: {
                  Accept: "application/json",
                  "Content-Type": "application/json",
                },
                body: paymentParams,
              })
              .then((result) => result.json())
              .then((json) => json.answer.formToken)
              .catch((error) => {
                console.error(error);
              });
            };

• The step of validating the cart is crucial. Before you transmit it to us, you must check on your servers that the amount corresponds to the one in the cart.
• Calling the web service from the mobile application is amounts to making your call keys available to it (and to potential hackers), which is contrary to the security rules.

Displaying the payment screen

Once the formToken is received in the mobile application, you must transmit it to our payment SDK by calling the process method with the following parameters :

The SDK then checks the formToken consistency and displays the available payment methods.

Example of a call:

            process(
            formToken!,
            options,
            async (result) => {
              // onSuccess
              // Verify the payment using your server
              verifyPayment(result.response)
              .then(() => {
                Alert.alert(`Payment success`);
              })
              .catch(() => {
                Alert.alert(`Payment verification fail`);
              });
            },
            async (result) => {
              // onError
              Alert.alert(result.error.errorMessage);
            }
            );

Description of the LyraResponse object

The LyraResponse object is returned in both onSuccess and onError. It is an object of type JSONObject. In case of success, it is necessary to check its integrity before displaying the payment result.

In case the transaction was initiated on the server side, it will be possible to simply retrieve the payment details.

Example: .

{
   "kr-hash":"80f5188e757c1828e8d4ccab87467eb50c4299e4057fa03b3f3185342f6d509c",
   "kr-hash-algorithm":"sha256_hmac",
   "kr-answer-type":"V4\/Payment",
   "kr-answer": "{
      "shopId":"65512466",
      "orderCycle":"CLOSED",
      "orderStatus":"PAID",
      "serverDate":"2019-03-01T10:54:45+00:00",
      "orderDetails":{
         "orderTotalAmount":1100,
         "orderEffectiveAmount":1100,
         "orderCurrency":"EUR",
         "mode":"TEST",
         "orderId":null,
         "_type":"V4\/OrderDetails"
      },
      "customer":{
         "billingDetails":{
            "address":null,
            "category":null,
            "cellPhoneNumber":null,
            ...
         },
         "email":null,
         "reference":null,
         "shippingDetails":{
            "address":null,
            "address2":null,
            "category":null,
            ...
         },
         "extraDetails":{
            "browserAccept":null,
            "fingerPrintId":null,
            "ipAddress":"77.136.84.251",
            "browserUserAgent":"{\"deviceName\":\"Xiaomi Mi MIX 2S\",\"os\":\"Android\",\"osVersion\":\"[9]\",\"sdkVersion\":28,\"isMobile\":true}",
            "_type":"V4\/Customer\/ExtraDetails"
         },
         "shoppingCart":{
            "insuranceAmount":null,
            "shippingAmount":null,
            "taxAmount":null,
            "cartItemInfo":null,
            "_type":"V4\/Customer\/ShoppingCart"
         },
         "_type":"V4\/Customer\/Customer"
      },
      "transactions":[
         {
            "shopId":"65512466",
            "uuid":"64d704a9bb664898954c3ef537982f99",
            "amount":1100,
            "currency":"EUR",
            "paymentMethodType":"CARD",
            "status":"PAID",
            "detailedStatus":"AUTHORISED",
            "operationType":"DEBIT",
            "creationDate":"2019-03-01T10:54:44+00:00",
            ...
         }
      ],
      "_type":"V4\/Payment"
   }"
}

The response contains the same elements as the ones sent in the IPN:

The kr-answer object contains the elements described here.

In some cases, it may be that the transaction could not be initiated on the server side. It will be possible to find the error returned by the API in the json (you can find the format here: Error codes ).

Check the transaction status

Once the payment has been finalized, regardless of whether was accepted or rejected, you will be notified in two 2 ways:

• Via a call (IPN) to your merchant server, if the Merchant is registered on our payment gateway.
• By calling the onSuccess or onError callback on the mobile application side.

It is necessary to check the integrity of the message (go here for more details), and to launch business processing on the server side (when the IPN is received).

Our sample code provides an example of message integrity check via your merchant server, i.e. the verifyResult endPoint called in the verifyResult method of the application.

Here's an example code based on the merchant server provided.

            const verifyPayment = async (paymentResult: any) => {
              return fetch(config.merchantServerUrl + "/verifyResult", {
                method: "POST",
                headers: {
                  Accept: "application/json",
                  "Content-Type": "application/json",
                },
                body: paymentResult,
              });
            };

Customize the SDK

Theme

It is possible to customize the SDK so that the views generated via the SDK (payment form) are displayed with the same colors and font as those used in your application.

You can define:

• One main color,
• A secondary color,
• the font to be used for all the texts that appear in the SDK.

The main color allows to modify:

• the header background color,
• The background color of the “Pay” button,
• the color of the word for closing the CVV tooltip pop-up,
• the color of the word for closing the brand selection pop-up,
• the color for highlighting the field and of its label when it is being edited,
• the color of the text in the payment in progress message,
• the color of the spinner in the current payment message.

The secondary color allows to change:

• the color of the arrow image for going back in the SDK header,
• the color of the texts in the SDK header,
• the text color of the “Pay” button.

For the customization to be taken into account, the following modifications must be made in the native part of the project: iOS and Android :

iOS

Add a PaymentSdkTheme.plist file to your project's iOS folder and specify in this file the colors to be used in hexadecimal :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>PaymentSDKColor</key>
	<dict>
		<key>PaymentSDK_PrimaryColor</key>
		<string>#293C7A</string>
		<key>PaymentSDK_SecondaryColor</key>
		<string>#FFFFFF</string>
	</dict>
</dict>
</plist>

It is also possible to change the font with the key PaymentSDKFont.

Then, add the PaymentSdkTheme.plist file and the font file to your iOS project (from Xcode, open the .xcworkspace file).

Android

Define the colors in your colors.xml file:

<color name="payment_sdk_PrimaryColor">#293C7A</color>
<color name="payment_sdk_SecondaryColor">#FFFFFF</color>

To customize the font you just need to override the necessary style in the styles.xml file:

<style name="PaymentSDK_Theme">
    <item name="android:fontFamily"></i>casual</item></style>

Texts

It is also possible to customize the text of the payment button. To do so, specify the optional "options" parameter when calling the process.

PAY button

• The text of the PAY button can be customized.

Specify the key customPayButtonLabel.

Header

• If the text is forced and there is no orderId, it will replace the default text, which is "Payment" or "Card registration".
• On the other hand, if an orderId is specified, we will continue to display the "OrderId" value.

Specify the key customHeaderLabel.

Payment popup

• The popup text that opens when clicked PAY button can also be customized.

Specify the key customPopupLabel.

Enable the card scan feature

The card scan feature allows a user to avoid entering their card information manually and, instead, use the camera on their mobile device to scan it and fill out the payment form automatically.

Please note : Actually, this feature is only available for iOS devices.

To enable this feature, when initializing the SDK, you must send true as a value to the cardScanningEnabled key in the configuration options dictionary (See Initialize SDK ).

In the Info.plist file of your application (in the iOS folder), add the NSCameraUsageDescription key and describe the reason for using the camera.

Enable NFC feature

NFC feature allows a user not to enter their card information manually and, instead, to use NFC to scan the card and fill out the payment form automatically.

Please note : This feature is only available for Android devices.

To enable this feature, when initializing the SDK, you must send true as a value to the nfcEnabled key in the configuration options (See Initialize SDK ).

Add the following permission in the AndroidManifest.xml file of your application:

<uses-permission android:name="android.permission.NFC" />

Limitations

The following SDK functions are not available in the Native Module:

• The methodcancelProcess().
• Card scanning on Android devices.

Using our sdk in an Expo React Native application

If you have an Expo project (managed workflow) to add the payment sdk to your application:

1. Add our [Native Module] dependency (https://www.npmjs.com/package/@lyracom/react-native-sdk-payment-module) to your package.json file.

{
  "dependencies": {
   	 "@lyracom/react-native-sdk-payment-module": "^1.0.0",
    },
}

2. Add the following dependencies to your package.json file:

{
  "dependencies": {
   	"expo-build-properties": "~0.4.1",
  		"expo-dev-client": "^2.0.1",
    },
}

3. In your app.json file add :

{
 "expo": {
   "plugins": [
     [
       "expo-build-properties",
       {
         "ios": {
           "useFrameworks": "dynamic"
         }
       }
     ]
   ]
 }}

4. Runyarn.

Attention : Once our [Native Module] (https://www.npmjs.com/package/@lyracom/react-native-sdk-payment-module) is added to your Expo application (managed workflow), it won't be possible to test it using Expo Go. You'll need to build an application with the help of expo-dev-client. To do this :

• Runeas build --profile development --platform ios.
• Runeas build --profile development --platform android.
• Install the generated application on the corresponding device.
• Runexpo start --dev-client.

You'll find sample code for integrating our SDK into a Expo React Native application in the Github repository

Copyrights