API ReferenceIntegrationsKnowledge Base

Cordova SDK Integration - Razorpay Standard Checkout

You can start accepting payments from customers on your app built using Cordova, by integrating with Razorpay Cordova Standard SDK.

The Cordova Standard SDK acts as a wrapper around the Razorpay Standard SDK to build a dynamic and responsive Checkout interface for your iOS or Android application. Learn how to link the SDK with your Cordova project and integrate with Razorpay Checkout.

Guidelines#

  • Add the integration code snippet after deviceready event.

  • On browser platform, change the Content Security Policy to whitelist the razorpay.com domain.

Copy<meta http-equiv="Content-Security-Policy" content="default-src 'self' https://*.razorpay.com data: gap: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">
  • Ionic serve does not support cordova browser plugins, we do not support ionic serve at the moment. Try using the ionic cordova run browser command instead. Learn more.

Prerequisites#

  • Sign up for a Razorpay account.
  • In the Razorpay Dashboard, navigate to Settings → API Keys → Generate Key to generate API key.
    • Generate keys in the test mode to test the integration.
    • Generate keys in the Live Mode when you are ready to accept payments from your customers.
  • Read our Payment Flow document before proceeding with the integration.

Integration Steps#

  1. Create an Order from your Server
  2. Install Razorpay Cordova Plugin
  3. Add Checkout Code in Index.js file
  4. Store Fields in your Server
  5. Verify Payment Signature

Step 1: Create an Order from your Server#

Use the below endpoint to create an Order.

/orders
Copycurl -X POST https://api.razorpay.com/v1/orders -H 'content-type:application/json' -d '{ "amount": 50000, "currency": "INR", "receipt": "rcptid_11" }'
Copytry { 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); } catch (RazorpayException e) { // Handle Exception System.out.println(e.getMessage()); }
Copyorder_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$order = $client->order->create([ 'receipt' => 'order_rcptid_11', 'amount' => 50000, // amount in the smallest currency unit 'currency' => 'INR',// <a href="/docs/payment-gateway/payments/international-payments/#supported-currencies" target="_blank">See the list of supported currencies</a>.) ]);
CopyDictionary<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);
Copyoptions = amount: 50000, currency: 'INR', receipt: '<order_rcptid_11>', order = Razorpay::Order.create
Copyvar 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); });
Copy{ "id": "order_DBJOWzybf0sJbb", "entity": "order", "amount": 50000, "amount_paid": 0, "amount_due": 50000, "currency": "INR", "receipt": "rcptid_11", "status": "created", "attempts": 0, "notes": [], "created_at": 1566986570 }

Successful creation of the Order returns an id (referred to as order_id) that should be stored against the Order defined in your system.

Read more: Learn 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.
receipt optional
string Your receipt id for this order should be passed here. Maximum length 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 2: Install Razorpay Cordova plugin#

In your Cordova project folder, run this command to install the plugin:

Copycd your-project-folder cordova platform add android # optional cordova platform add ios # make sure your ios version is ios@5 or latest. cordova platform add browser # optional cordova plugin add https://github.com/razorpay/razorpay-cordova.git --save
Copycd your-project-folder ionic cordova platform add ios ionic cordova platform add android ionic cordova platform add browser ionic cordova plugin add https://github.com/razorpay/razorpay-cordova.git --save

Step 3: Add Checkout Code#

Cordova#

In the index.js file, add the Checkout code, along with the order_id generated in the first step. Add the API key generated by you on the Razorpay Dashboard.

Ionic#

  1. In your app's home.page.html file, add the following code. This code generates the button which your customer will click to open the Checkout and make the payment.

    Copy<ion-button (click)="payWithRazorpay()"> Pay With Razorpay </ion-button>
  2. In your app's home.page.ts file, import RazorpayCheckout as shown:

    Copydeclare var RazorpayCheckout:any;
  3. Add the Checkout code along with the order_id generated in the first step. Add the API key generated by you on the Razorpay Dashboard.

Checkout Code#

Complete list of checkout parameters.

Copyvar rzpOptions = { key: "<YOUR_KEY_ID>", amount: "50000", // 50000 paise = INR 500 name: "Acme Corp", description: "Get the best deals", image: "https://i.imgur.com/n5tjHFD.png", order_id:"order_DBJOWzybf0sJbb", handler: function (response){ alert(response.razorpay_payment_id); alert(response.razorpay_order_id); alert(response.razorpay_signature) }, prefill: { name: "Gaurav Kumar", email: "gaurav.kumar@example.com" }, notes: { address: "Hello World" }, theme: { color: "#3399cc" } }; var successCallback = function(payment_id) { alert('payment_id: ' + payment_id) }; var cancelCallback = function(error) { alert(error.description + ' (Error '+error.code+')') };
CopypayWithRazorpay(){ var options = { description: 'Credits towards consultation', image: 'https://i.imgur.com/3g7nmJC.png', order_id: 'order_DBJOWzybf0sJbb', currency: 'INR', key:'<YOUR_KEY_ID>', amount:'5000', name: 'Acme Corp', theme: { color: '#3399cc' } } var successCallback = function(success) { alert('payment_id: ' + success.razorpay_payment_id) var orderId = success.razorpay_order_id var signature = success.razorpay_signature } var cancelCallback = function(error) { alert(error.description + ' (Error '+error.code+')') } RazorpayCheckout.on('payment.success', successCallback) RazorpayCheckout.on('payment.cancel', cancelCallback) RazorpayCheckout.open(options) }

Step 4: Store Fields in your 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" }
razorpay_payment_id
string Unique identifier for the payment returned by Checkout only for successful payments.
razorpay_order_id
string Unique identifier for the order returned by Checkout.
razorpay_signature
string Signature returned by the checkout. This is used to verify the payment.

Step 5: Verify the 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 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#

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' , 'order_id' => '12122'); $order = $api->utility->verifyPaymentSignature($attributes)
Copyrequire 'razorpay' Razorpay.setup('key_id', 'key_secret') payment_response = { '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 = { '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.

Step 6: Android-specfic - Android Lifecycle Guide#

It is recommended that you read the Android Lifecycle Guide before proceeding with this section.

Since our plugin launches a new activity on Android, the cordova activity goes in the background and might get destroyed by the Android System. For this scenario, you need to add the following code to make sure the payment result is delivered after the cordova activity is recreated:

Copy// You need to register an event listener for the `resume` event document.addEventListener('resume', onResume, false); var onResume = function(event) { // Re-register the payment success and cancel callbacks RazorpayCheckout.on('payment.success', successCallback) RazorpayCheckout.on('payment.cancel', cancelCallback) // Pass on the event to RazorpayCheckout RazorpayCheckout.onResume(event); };

Payment Capture Settings#

Once authorized, you need to capture payments made by customers for them to get settled to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time period. You can:

Read more: Capture Settings for payments.

Test the Integration#

Now that the integration is complete, you must ensure that your integration works as expected. You can make a test transaction using the test cards, verify the payment status from 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 on 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

Mastercard

Domestic

5104 0600 0000 0008

Visa

Domestic

4111 1111 1111 1111

Mastercard

International

5555 5555 5555 4444
5105 1051 0510 5100

Visa

International

4012 8888 8888 1881
4000 1841 8621 8826

Verify the Payment Status#

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

From the Dashboard#

  1. Log into your Dashboard and navigate to TransactionsPayments.
  2. Look 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.

When the customer makes a successful payment on the Checkout, payment.authorized event is created in Razorpay.

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, you are now ready to take your integration live. Once you are confident that the integration is working fine, you can switch to the live mode and start accepting payments from customers. But first, you need to 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 SettingsAPI KeysGenerate Key to generate API key for live mode.
  3. Download the keys and save it securely.
  4. Replace the test API key with the Live Key in the Checkout code and start accepting real-time payments.
×