API ReferenceIntegrationsKnowledge Base

Capacitor Android and iOS Plugin - Razorpay Standard Checkout

Capacitor is an open source native runtime for building Web Native apps. You can use the Razorpay Capacitor plugin to accept payments on your Capacitor apps.

The Razorpay Capacitor plugin acts as a wrapper around our native Android and iOS SDKs.

Integration Steps🔗

Follow these steps to integrate your Capacitor application with the Razorpay Payment Gateway:

  1. Create an Order in Server.
  2. Install the Razorpay Capacitor Plugin.
  3. Add the Checkout class in MainActivity.java (Android Only).
  4. Add the Checkout Code.
  5. Store Fields in Server.
  6. 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 post-integration section for more details.

Step 1: Create an Order in Server🔗

Orders API helps to prevent multiple payments by binding a single successful payment to an order.

Sample Code

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

Copycurl -X POST https://api.razorpay.com/v1/orders -u <YOUR_KEY_ID>:<YOUR_SECRET> -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/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 }

Parameters

Here is the list of parameters for creating the order:

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. Length must be of 3 characters.
receipt optional
string Your receipt id for this order should be passed here. Maximum length 40 characters.
notes optional
json 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”.
partial_payment optional
boolean Indicates whether the customer can make a partial payment. Possible values:
  • true - The customer can make partial payments.
  • false (default) - The customer cannot make partial payments.

A successful creation of the Order returns the order_id that you need to store against the Order defined in your system.

Step 2: Install the Razorpay Capacitor Plugin🔗

Run the following command on your command prompt to install the plugin:

Copynpm i -S https://github.com/razorpay/razorpay-capacitor.git

Step 3: Add the Checkout class in MainActivity.java (Android Only)🔗

Add the Checkout class to the ArrayList in the MainActivity class in {{projectDir}}/android/src/main/MainActivity.java. The sample code is given below:

Copyimport com.ionicframework.capacitor.Checkout; public class MainActivity extends BridgeActivity { @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Initializes the Bridge this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{ // Additional plugins you've installed go here // Ex: add(TotallyAwesomePlugin.class); add(Checkout.class); }}); } }

Step 4: Add the Checkout Code🔗

Add the Checkout code to your project. Ensure that you pass the order_id that you received in the response of the first step.

Copyimport 'capacitor-razorpay'; import { Plugins } from '@capacitor/core'; const { Checkout } = Plugins; async loadCheckout() { const options = { key: '[YOUR_KEY_ID]', amount: '5000', order_id: 'order_DBJOWzybf0sJbb', //Obtained in response of Step 1. description: 'Credits towards consultation', image: 'https://i.imgur.com/3g7nmJC.png', currency: 'INR', name: 'Acme Corp', prefill: { email: 'gaurav.kumar@example.com', contact: '9999999999', name: 'Gaurav Kumar' }, theme: { color: '#3399cc' } } try { let data = (await Checkout.open(options)); console.log(data['response']['razorpay_payment_id']) } catch (error) { console.log(error['description']) } }

Request Parameters

key mandatory

string API Key ID that must generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100, enter 10000.

currency mandatory

string The currency in which the payment should be made by the customer. See the list of supported currencies.

name mandatory

string The merchant/company name shown in the Checkout form.

description optional

string Description of the purchase item shown in the Checkout form. Must start with an alphanumeric character.

image optional

string Link to an image (usually your business logo) shown in the Checkout form. Can also be a base64 string, if loading the image from a network is not desirable.

order_id mandatory

string Order ID generated via Razorpay Orders API.

prefill

object You can prefill the following details on Checkout.

name optional
string Cardholder's name to be pre-filled if customer is to make card payments on Checkout.
email optional
string Email address of the customer.
contact optional
string Phone number of the customer. The expected format of the phone number is + {country code}{phone number}. If the country code is not specified, 91 will be used as the default value. This is particularly important while prefilling contact of customers with phone numbers issued outside India. Examples:
  • +14155552671 (a valid non-Indian number)
  • +919977665544 (a valid Indian number).
    If 9977665544 is entered, +91 is added to it as +919977665544.
method optional
string Pre-selection of the payment method for the customer. Will only work if contact and email are also pre-filled. Possible values
  • card
  • netbanking
  • wallet
  • emi
  • upi
notes optional

object Set of key-value pairs that can be used to store additional information about the payment. It can hold a maximum of 15 key-value pairs, each 256 characters long (maximum).

theme

object Thematic options to modify the appearance of Checkout.

hide_topbar optional
boolean Used to display or hide the top bar on the Checkout form. This bar shows the selected payment method, phone number and gives the customer the option to navigate back to the start of the Checkout form. Possible values are:
  • true - Hides the top bar
  • false (default) - Displays the top bar.
color optional
string Enter your brand colour's HEX code to alter the appearance of Checkout form.
backdrop_color optional
string Enter a HEX code to change the Checkout's backdrop colour.
modal

object Options to handle the Checkout modal.

backdropclose optional
boolean Indicates whether clicking the translucent blank space outside the Checkout form should close the form. Possible values are:
  • true - Closes the form when your customer clicks outside the checkout form.
  • false (default) - Does not close the form when customer clicks outside the checkout form.
escape optional
boolean Indicates whether pressing the escape key should close the Checkout form. Possible values are:
  • true (default) - Closes the form when the customer presses the escape key.
  • false - Does not close the form when the customer presses the escape key.
handleback optional
boolean Determines whether Checkout must behave similar to the browser when back button is pressed. Possible values:
  • true (default) - Checkout behaves similarly to the browser. That is, when the browser's back button is pressed, the Checkout also simulates a back press. This happens as long as the Checkout modal is open.
  • false - Checkout does not simulate a back press when browser's back button is pressed.
confirm_close optional
boolean Determines whether a confirmation dialog box should be shown when customers attempt to close Checkout. Possible values:
  • true - Confirmation dialog box is shown.
  • false (default) - Confirmation dialog box is not shown.
ondismiss optional
function Used to track the status of Checkout. You can pass a modal object with ondismiss: function(){} as options. This function is called when the modal is closed by the user.
animation optional
boolean Show an animation before loading of Checkout.
  • true(default) - Animation appears.
  • false - Animation does not appear.
subscription_id optional

string If you are accepting recurring payments using Razorpay Checkout, you should pass the relevant subscription_id to the Checkout. Learn more about Subscriptions on Checkout.

subscription_card_change optional

boolean Permit or restrict customer from changing the card linked to the subscription. You can also do this from the hosted page. Possible values:

  • true - Allow the customer to change the card from Checkout.
  • false (default) - Do not allow the customer to change the card from Checkout.
recurring optional

boolean Determines if you are accepting recurring (charge-at-will) payments on Checkout via instruments such as emandate, paper NACH and so on. Possible values:

  • true - You are accepting recurring payments.
  • false (default) - You are not accepting recurring payments.
callback_url optional

string Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is whitelisted.

redirect optional

boolean Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. callback_url must be passed while using this parameter. Possible values:

  • true - Customer is redirected to the specified callback URL in case of payment failure.
  • false (default) - Customer is shown the Checkout popup to retry the payment.
customer_id optional

string Unique identifier of customer. Used for:

timeout optional

integer Sets a timeout on Checkout, in seconds. After the specified time limit, customer will not be able to use Checkout.

remember_customer optional

boolean Determines whether to allow saving of cards. Can also be configured via the Razorpay Dashboard. Possible values:

  • true - Enables card saving feature.
  • false (default) - Disables card saving feature.
readonly

object Marks fields as read-only.

contact optional
boolean Used to set the contact field as readonly. Possible values: - true - Customer will not be able to edit this field. - false (default) - Customer will be able to edit this field.
email optional
boolean Used to set the email field as readonly. Possible values: - true - Customer will not be able to edit this field. - false (default) - Customer will be able to edit this field.
name optional
boolean Used to set the name field as readonly. Possible values: - true - Customer will not be able to edit this field. - false (default) - Customer will be able to edit this field.
send_sms_hash optional

boolean Used to auto-read OTP for cards and net banking pages. Applicable from Android SDK version 1.5.9 and above. Possible values:

  • true - OTP is auto-read.
  • false (default) - OTP is not auto-read.
allow_rotation optional

boolean Used to rotate payment page as per screen orientation. Applicable from Android SDK version 1.6.4 and above. Possible values:

  • true - Payment page can be rotated.
  • false (default) - Payment page cannot be rotated.
retry optional

object Parameters that enable retry of payment on the checkout.

enabled
boolean Determines whether the customers can retry payments on the checkout. Possible values:
  • true- Enables customers to retry payments.
  • false (default) - Disables customers from retrying the payment.
max_count
integer The number of times the customer can retry the payment. Recommended to set this to 4. Having a larger number here can cause loops to occur.

Enable UPI Intent on iOS

Provide your customers a better payment experience by enabling UPI Intent on your app's Checkout form. In the UPI Intent flow:

  • Customer selects UPI as the payment method in your iOS app. A list of UPI apps supporting the intent flow is displayed. For example, PhonePe, Google Pay and Paytm.
  • Customer selects their preferred app. The UPI app opens with pre-populated payment details.
  • Customer enters their UPI PIN to complete their transactions.
  • Once the payment is successful, the customer is redirected to your app or website.

To enable this in your iOS integration, you must make the following changes in your app's info.plist file.

Copy<key>LSApplicationQueriesSchemes</key> <array> <string>tez</string> <string>phonepe</string> <string>paytmmp</string> </array>

Know more about UPI Intent and its benefits.

Step 5: 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" }
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 6: 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:

Platform

Link

Java

https://github.com/razorpay/razorpay-java

PHP

https://github.com/razorpay/razorpay-php

Ruby

https://github.com/razorpay/razorpay-ruby

Python

https://github.com/razorpay/razorpay-python

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

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 Razorpay Dashboard, subscribe to the Webhook event or poll our APIs.

From the Dashboard

  1. Log into the Rzaorpay Dashboard and navigate to Transactions → Payments.
  2. Look if a payment_ID is generated. If no payment_ID is 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.

Know more about set up of webhooks.

When the customer makes a successful payment on the Checkout, payment.authorized event is created in Razorpay. When an order is successfully paid, order.paid 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 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 the Razorpay 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.

Timeouts🔗

The transaction timeout is applicable only when your customer attempts the payment.

The timeout is 3 to 15 minutes for an attempted payment. If there is a payment failure due to timeout, the customer is redirected to the Checkout page.

×