API ReferenceIntegrationsKnowledge Base

React Native Standard SDK - Android Integration

React Native Version 0.60+:
This document elaborates the SDK integration steps for apps running on React Native version 0.60+. You can find the SDK integration steps for apps with React Native version 0.59 and lower on GitHub.

Video Tutorial🔗

Watch this video to learn how to integrate Razorpay Payment Gateway on your React Native Android app.


  • Understand the payment flow process.
  • Create a Razorpay Account.
  • Generate API Keys in Test Mode. Once you are done with the integration, you can generate Live Mode API keys and replace them in the integration.

The compileSdkVersion is the version of Android. You will need to increase the value of minSdkVersion to at least 19 in the build.gradle file in Android folder for it to work with the latest Android SDK Build Tools version. Using it with a lower minSdkVersion version will lead to errors.

Integration Steps🔗

Steps to integrate Razorpay React Native SDK for Android.

  1. Install Razorpay React Native SDK
  2. Import Razorpay Package in MainApplication.java
  3. Add Razorpay SDK in Settings Gradle File
  4. Add Dependency in App Build Gradle File
  5. Run React Native App
  6. Create an Order in Server
  7. Add Razorpay Checkout Options to .js File
  8. Store Fields in Server
  9. Verify Payment Signature

Post-Integration Steps:
Once you have successfully completed the integration, you can setup webhooks, make test payments, replace test key with live key and integrate with other APIs. Refer to the Test the Integration section for more details.

Step 1: Install Razorpay React Native SDK🔗

Install the SDK using the following npm command in the Terminal window. If you are using Windows, please use Git Bash instead of Command Prompt window. Ensure that you run this code within your React Native project folder in Terminal window.

Copy$ npm install react-native-razorpay --save

Step 2: Import Razorpay Package in MainApplication.java🔗

Launch Android Studio and open the MainAplication.java file from your project folder. Add the following code:

Copyimport com.razorpay.rn.RazorpayPackage;

Also, add new RazorpayPackage() to the list returned by the getPackages() method.

Copy protected List<ReactPackage> getPackages() { @SuppressWarnings("UnnecessaryLocalVariable") List<ReactPackage> packages = new PackageList(this).getPackages(); // Packages that cannot be autolinked yet can be added manually here, for example: packages.add(new RazorpayPackage()); return packages; }

Step 3: Add Razorpay SDK in Settings Gradle File🔗

Append the following lines to the settings.gradle file.

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

Step 4: Add Dependency in App Build Gradle File🔗

Add the following lines in the dependencies section of your app's build.gradle file.

Copyimplementation project(':react-native-razorpay')

Step 5: Run React Native App🔗

Run the React Native app.

Copynpx react-native run-android

This links the SDK with your React Native project.

Step 6: Create an Order in Server🔗

Use the below endpoint to create an order in your (backend) server.

Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \ -X POST https://api.razorpay.com/v1/orders \ -H "content-type: application/json" \ -d '{ "amount": 50000, "currency": "INR", "receipt": "receipt#1" }'
CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); JSONObject orderRequest = new JSONObject(); orderRequest.put("amount", 50000); // amount in the smallest currency unit orderRequest.put("currency", "INR"); orderRequest.put("receipt", "order_rcptid_11"); Order order = razorpay.Orders.create(orderRequest);
Copyimport razorpay client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET")) order_amount = 50000 order_currency = 'INR' order_receipt = 'order_rcptid_11' notes = {'Shipping address': 'Bommanahalli, Bangalore'} # OPTIONAL client.order.create(amount=order_amount, currency=order_currency, receipt=order_receipt, notes=notes)
Copy$api = new Api($key_id, $secret); $order = $client->order->create([ 'receipt' => 'order_rcptid_11', 'amount' => 50000, 'currency' => 'INR' ]);
CopyRazorpayClient client = new RazorpayClient(your_key_id, your_secret); Dictionary<string, object> options = new Dictionary<string,object>(); options.Add("amount", 50000); // amount in the smallest currency unit options.Add("receipt", "order_rcptid_11"); options.Add("currency", "INR"); Order order = client.Order.Create(options);
Copyrequire "razorpay" Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET') options = amount: 50000, currency: 'INR', receipt: '<order_rcptid_11>'
Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' }) var options = { amount: 50000, // amount in the smallest currency unit currency: "INR", receipt: "order_rcptid_11" }; instance.orders.create(options, function(err, order) { console.log(order); });
Copyimport ( razorpay "github.com/razorpay/razorpay-go" ) client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET") data := map[string]interface{}{ "amount": 1234, "currency": "INR", "receipt": "some_receipt_id" } body, err := client.Order.Create(data)
Copy{ "id": "order_EKwxwAgItmmXdp", "entity": "order", "amount": 50000, "amount_paid": 0, "amount_due": 50000, "currency": "INR", "receipt": "receipt#1", "offer_id": null, "status": "created", "attempts": 0, "notes": [], "created_at": 1582628071 }

An order id (referred as order_id) is generated on the successful creation of an order. You should store this order id in your system against the order.

Know more about Orders API.

Request Parameters

amount mandatory
integer The transaction amount, expressed in the currency subunit, such as paise (in case of INR). For example, for an actual amount of ₹299.35, the value of this field should be 29935.
currency mandatory
string The currency in which the transaction should be made. See the list of supported currencies. Default is INR. Length must be of 3 characters.
receipt optional
string Your receipt id for this order should be passed here. Maximum length of 40 characters.
notes optional
object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Step 7: Add Razorpay Checkout Options to .js File🔗

To integrate the Razorpay Checkout with your React Native app, you must add the Checkout Display Options in the .js file.

Open the .js file in your project folder and perform the following:

  1. Import the RazorpayCheckout module to your component.
Copyimport RazorpayCheckout from 'react-native-razorpay';
  1. Call the RazorpayCheckout.open method with the payment options. The method returns a JS Promise where the then part corresponds to a successful payment and the catch part corresponds to payment failure.
Copy<TouchableHighlight onPress={() => { var options = { description: 'Credits towards consultation', image: 'https://i.imgur.com/3g7nmJC.png', currency: 'INR', key: '<YOUR_KEY_ID>', amount: '5000', name: 'Acme Corp', order_id: 'order_DslnoIgkIDL8Zt',//Replace this with an order_id created using Orders API. prefill: { email: 'gaurav.kumar@example.com', contact: '9191919191', name: 'Gaurav Kumar' }, theme: {color: '#53a20e'} } RazorpayCheckout.open(options).then((data) => { // handle success alert(`Success: ${data.razorpay_payment_id}`); }).catch((error) => { // handle failure alert(`Error: ${error.code} | ${error.description}`); }); }}>

A descriptive list of valid options for checkout is available.

Step 8: Store Fields in Server🔗

A successful payment returns the following fields to the Checkout Form. Make provisions to store these fields on your server. You can confirm the authenticity of these details by verifying the signature in the next step.

Copy{ "razorpay_payment_id": "pay_29QQoUBi66xm2f", "razorpay_order_id": "order_9A33XWu170gUtm", "razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d" }
string Unique identifier for the payment returned by Checkout only for successful payments.
string Unique identifier for the order returned by Checkout.
string Signature returned by the Checkout. This is used to verify the payment.

Step 9: Verify Payment Signature🔗

This is a mandatory step that allows you 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:

    Copygenerated_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

The links to the Razorpay SDKs for the supported platforms are given below:











Copy/** * This class defines common routines for generating * authentication signatures for Razorpay Webhook requests. */ public class Signature { private static final String HMAC_SHA256_ALGORITHM = "HmacSHA256"; /** * Computes RFC 2104-compliant HMAC signature. * * @param data * The data to be signed. * @param key * The signing key. * @return * The Base64-encoded RFC 2104-compliant HMAC signature. * @throws * java.security.SignatureException when signature generation fails */ public static String calculateRFC2104HMAC(String data, String secret) throws java.security.SignatureException { String result; try { // get an hmac_sha256 key from the raw secret bytes SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(), HMAC_SHA256_ALGORITHM); // get an hmac_sha256 Mac instance and initialize with the signing key Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM); mac.init(signingKey); // compute the hmac on input data bytes byte[] rawHmac = mac.doFinal(data.getBytes()); // base64-encode the hmac result = DatatypeConverter.printHexBinary(rawHmac).toLowerCase(); } catch (Exception e) { throw new SignatureException("Failed to generate HMAC : " + e.getMessage()); } return result; } }
Copyuse Razorpay\Api\Api; $api = new Api($key_id, $key_secret); $attributes = array('razorpay_signature' => '23233', 'razorpay_payment_id' => '332' , 'razorpay_order_id' => '12122'); $order = $api->utility->verifyPaymentSignature($attributes)
Copyrequire 'razorpay' Razorpay.setup('key_id', 'key_secret') payment_response = { 'razorpay_order_id': '12122', 'razorpay_payment_id': '332', 'razorpay_signature': '23233' } Razorpay::Utility.verify_payment_signature(payment_response)
Copyimport razorpay client = razorpay.Client(auth = ('[key_id]', '[key_secret]')) params_dict = { 'razorpay_order_id': '12122', 'razorpay_payment_id': '332', 'razorpay_signature': '23233' } client.utility.verify_payment_signature(params_dict)

Post Signature Verification

After verifying the signature, fetch the order in your system that corresponds to the razorpay_order_id in your database. Mark it as successful and process the order.

Test Integration🔗

After the integration is complete, you need to test the integration to ensure that it is working as expected. You can make a test transaction using the test cards, verify the payment status from the Razorpay Dashboard, APIs or subscribe to related Webhook events to take appropriate actions at your end. After testing the integration in test mode, you can start accepting payments from your customers in real-time.

Test Payments🔗

You can make test payments using any of the payment methods configured at the Checkout. No money is deducted from the customer's account as this is a simulated transaction. In the Checkout code, ensure that you have entered the API keys generated in the test mode.

Test Cards

You can use any of the test cards to make transactions in the test mode. Use any valid expiration date in the future and any random CVV to create a successful payment.

Card Network

Domestic / International

Card Number



5104 0600 0000 0008



4111 1111 1111 1111



5555 5555 5555 4444
5105 1051 0510 5100



4012 8888 8888 1881
4000 1841 8621 8826

Verify the Payment Status🔗

You can track the status of the payment from the Razorpay Dashboard, subscribe to the Webhook event or poll our APIs.

From the Dashboard

  1. Log into the Dashboard and navigate to Transactions → Payments.
  2. Check if a payment_ID has been generated. If no payment_ID has been generated, it means that the transaction has failed.

Subscribe to Webhook events

You can subscribe to a Webhook event that is generated when a certain event happens in our server. When one of those events is triggered, Razorpay sends the Webhook payload to the configured URL.

Learn how to set up Webhooks.

Poll APIs

You can retrieve the status of the payments by polling our Payment APIs.

Accept Live Payments🔗

After testing the flow of funds end-to-end in test mode and confident that the integration is working as expected, switch to the live mode and start accepting payments from customers. However, make sure that you swap the test API keys with the live keys.

To generate API key in live mode:

  1. Log into Dashboard and switch to Live mode on the menu.
  2. Navigate to Settings → API Keys → Generate Key to generate API key for live mode.
  3. Download the keys and save them securely.
  4. Replace the test API key with the Live Key in the Checkout code and start accepting real-time payments.