1. Build Integration

1.1 Install Razorpay React Native Custom UI SDK

You can install the SDK using NPM, Yarn and Expo.

To install using NPM, use the command given below:

npm install --save react-native-customui

To install using Yarn, use the command given below:

yarn add react-native-customui

To install using Expo, use the command given below:

npx expo install react-native-customui

1.2 Link SDK

• iOS

• Android

iOS

Automatic

Automatic linking is available only for iOS. The steps are given below:

1. Install the Razorpay React Native Custom UI SDK using the npm command.

   Install

   copy

   $ npm install react-native-customui --save

2. Navigate to the iOS folder on the terminal and run pod install.

Manual (via CocoaPods)

You can link the SDK manually using CocoaPods. To do this:

1. Add the following line to your build targets in your Podfile.
   

   copy

   pod 'react-native-customui', :path => '../node_modules/react-native-customui'

2. Run the following command:
   

   copy

   pod install

Manual (without CocoaPods)

If you do not use CocoaPods, follow these steps to link the SDK manually:

1. In XCode, in the Project Navigator:
   • Right click Libraries.
   • Add Files to [your project's name].
   • Navigate to node_modules/react-native-customui.
   • Add the .xcodeproj file.
2. In the project navigator, select your project.
   • Add the libRNDeviceInfo.a from the deviceinfo project to your project's Build Phases ➜ Link Binary With Libraries.
   • Click the .xcodeproj file you added before in the Project Navigator and navigate to the Build Settings tab. Ensure All is selected, and not Basic.
   • Look for Header Search Paths and ensure it contains both $(SRCROOT)/../react-native/React and $(SRCROOT)/../../React.
   • Mark both as recursive. It should be marked OK by default.
3. Run your project using cmd+R.

Expo Application

After adding the react-native-razorpay package, use the option to prebuild the app. This generates the iOS platform folders in the project to use native-modules.

npx expo prebuild

The application is installed on the device/emulator.

npx expo run:[ios] --device

Android

To link the SDK manually, follow these steps:

1. Open the android/app/src/main/java/[...]/MainApplication.java file. Add the following to the imports at the top of the file:
   

   Import

   copy

   import com.razorpay.rn.RazorpayPackage;

2. Add new RazorpayPackage() to the list returned by the getPackages() method.

3. Append the following lines to android/settings.gradle:
   

   Settings Gradle

   copy

   include ':react-native-razorpay'
   project(':react-native-razorpay').projectDir = new File(rootProject.projectDir,   '../node_modules/react-native-customui/android')

4. Insert the dependencies in android/app/build.gradle:
   

   Dependencies

   copy

   implementation project(':react-native-customui')

Expo Application

After adding the react-native-razorpay package, use the option to prebuild the app. This generates the android platform folders in the project to use native-modules.

npx expo prebuild

The application is installed on the device/emulator.

npx expo run:[android] --device

1.3 Create an Order in Server

Order is an important step in the payment process.

• An order should be created for every payment.
• You can create an order using the

  Orders API

  . It is a server-side API call. Know how to

  authenticate

  Orders API.
• The order_id received in the response should be passed to the checkout. This ties the Order with the payment and secures the request from being tampered.

API Sample Code

The following is a sample API request and response for creating an order:

curl -X POST https://api.razorpay.com/v1/orders
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
    "amount": 50000,
    "currency": "INR",
    "receipt": "rcptid_11",
    "partial_payment": true,
    "first_payment_min_amount": 23000
}'

Request Parameters

Here is the list of parameters and their description for creating an order:

Know more about

Error Response Parameters

The error response parameters are available in the

1.4 Fetch Payment Methods

You can accept payments through UPI, credit and debit cards, netbanking and wallets, as per the methods enabled on your account.

• When you use Razorpay React Native Standard SDK, you do not have to handle the availability of different payment methods.
  
• When creating a Custom checkout form, you must ensure that only the methods activated for your account are displayed to the customer. To get a list of available payment methods, call getPaymentMethods. This fetches the list of payment methods asynchronously and returns the result in JSON format in the onPaymentMethodsReceived callback.

Sample Code

The following API is used to fetch all enabled payment methods for a given API Key ID:

https://api.razorpay.com/v1/methods?key_id=[Your_Key_ID]

razorpay.getPaymentMethods(new PaymentMethodsCallback() {
	@Override
	public void onPaymentMethodsReceived(String result) {
		JSONObject paymentMethods = new JSONObject(result);
	}

	@Override
	public void onError(String error){

	}
	});
});

Check the

1.5 Import Razorpay Module

Import Razorpay module to your component:

import Razorpay from 'react-native-customui';

1.6 Add Razorpay Checkout Options to app.js File

Call the Razorpay.open method with the payment options. The method returns a JS Promise, where:

• The then part corresponds to a successful payment.
• The catch part corresponds to payment failure.

<TouchableHighlight onPress={() => {
  var options = {
    description: 'Credits towards consultation',
    currency: 'INR',
    key_id: 'rzp_test_1DP5mmOlF5G5ag',
    amount: '5000',
    email: 'void@razorpay.com',
    contact: '9999999123',
    method: 'netbanking',
    bank: 'HDFC'

  }
  Razorpay.open(options).then((data) => {
    // handle success
    alert(`Success: ${data.razorpay_payment_id}`);
  }).catch((error) => {
    // handle failure
    alert(`Error: ${error.code} | ${error.description}`);
  });
}}>

Know more about

Checkout Parameters

1.7 Store Fields in Server

A successful payment returns the following fields to the Checkout form.

• You need to store these fields in your server.
• You can confirm the authenticity of these details by verifying the signature in the next step.

1.8 Verify Payment Signature

This is a mandatory step to confirm the authenticity of the details returned to the Checkout form for successful payments.

To verify the razorpay_signature returned to you by the Checkout form:

1. Create a signature in your server using the following attributes:

   • order_id: Retrieve the order_id from your server. Do not use the razorpay_order_id returned by Checkout.
   • razorpay_payment_id: Returned by Checkout.
   • key_secret: Available in your server. The key_secret that was generated from the
     Razorpay Dashboard
     .

2. Use the SHA256 algorithm, the razorpay_payment_id and the order_id to construct a HMAC hex digest as shown below:

   HMAC Hex Digest

   copy

   generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);
   
     if (generated_signature == razorpay_signature) {
       payment is successful
     }

3. If the signature you generate on your server matches the razorpay_signature returned to you by the Checkout form, the payment received is from an authentic source.

Generate Signature on Your Server

Given below is the sample code for payment signature verification:

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String secret = "EnLs21M47BllR3X8PSFtjtbd";

JSONObject options = new JSONObject();
options.put("razorpay_order_id", "order_IEIaMR65cu6nz3");
options.put("razorpay_payment_id", "pay_IH4NVgf4Dreq1l");
options.put("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f");

boolean status =  Utils.verifyPaymentSignature(options, secret);

Post Signature Verification

After you have completed the integration, you can

M1 MacBook Changes

If you use M1 MacBook, you need to make the following changes in your podfile.

installer.pods_project.build_configurations.each do |config|
  config.build_settings["EXCLUDED_ARCHS[sdk=iphonesimulator*]"] = "arm64"
end

1.9 Verify Payment Status

You can track the payment status in three ways:

• From the Dashboard

  .

• Subscribe to the Webhook Events

  .

• Poll our APIs

  .

Verify Status from Dashboard

To verify the payment status from the Dashboard:

1. Log in to the

   Dashboard

   and navigate to Transactions → Payments.
2. Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.

Subscribe to Webhook Events

You can use Razorpay webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL. Know how to

Example

If you have subscribed to the order.paid webhook event, you will receive a notification every time a customer pays you for an order.

Poll APIs

Next Steps