1. Build Integration

Steps to integrate your Android application with Razorpay Android Custom SDK.

Follow these steps to integrate your Android application with Razorpay Android Custom SDK:



















Follow the steps given below to install the SDK in your Android project:

  • Add the code given below to your project's top-level build.gradle file:
    This gives access to the SDK library.

    dependencies {
    implementation 'com.razorpay:customui:3.9.20'

    This adds the dependencies for the SDK.

  • If you are using SDK version 3.9.5 or below, download the file and add it to the libs directory.

To instantiate Razorpay, pass a reference of your activity to the Razorpay constructor, as shown below:

import com.razorpay.Razorpay
Razorpay razorpay = new Razorpay(activity);

If you are using Proguard for your builds, you need to add the following lines to your proguard-rules.pro file.

-keepclassmembers class * {
@android.webkit.JavascriptInterface <methods>;
-keepattributes JavascriptInterface
-keepattributes *Annotation*
-dontwarn com.razorpay.**
-keep class com.razorpay.** {*;}
-optimizations !method/inlining/*
-keepclasseswithmembers class * {
public void onPayment*(...);

Add your

to AndroidManifest.xml.

Watch Out!

API keys should not be hardcoded in the app. It should be sent from your server-side as an app-related metadata fetch.

For additional support on Payment Methods, such as fetching bank or wallet logos, fetching card network and information on how to validate card information,

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

Handy Tips

The auto-OTP reading feature is available only for saved cards. Know more about


To set your API key programmatically, that is, at the runtime instead of statically defining it in your AndroidManifest.xml, you can pass it as a parameter to the Razorpay constructor, as shown below:

Razorpay razorpay = new Razorpay(activity, "YOUR_KEY_ID");

Order is an important step in the payment process.

  • An order should be created for every payment.
  • You can create an order using the . It is a server-side API call. Know how to 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.

You can create an order:

  • Using the sample code on the Razorpay Postman Public Workspace.
  • By manually integrating the API sample codes on your server.

You can use the Postman workspace below to create an order:

Handy Tips

Under the Authorization section in Postman, select Basic Auth and add the Key Id and secret as the Username and Password, respectively.

You can create an order manually by integrating the API sample codes on your server.

Use this endpoint to create an order using the Orders API.

curl -X POST https://api.razorpay.com/v1/orders
-H 'content-type:application/json'
-d '{
"amount": 500,
"currency": "INR",
"receipt": "qwsaq1",
"partial_payment": true,
"first_payment_min_amount": 230,
"notes": {
"key1": "value3",
"key2": "value2"
"id": "order_IluGWxBm9U8zJ8",
"entity": "order",
"amount": 5000,
"amount_paid": 0,
"amount_due": 5000,
"currency": "INR",
"receipt": "rcptid_11",
"offer_id": null,
"status": "created",
"attempts": 0,
"notes": [],
"created_at": 1642662092

Request Parameters



integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of ₹299.35, the value of this field should be 29935.



string The currency in which the transaction should be made. Refer to the

. Length must be of 3 characters.



string Your receipt id for this order should be passed here. Maximum length is 40 characters.



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”.



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.



integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of ₹7,000 is to be received from the customer in two installments of #1 - ₹5,000, #2 - ₹2,000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

Response Parameters

Descriptions for the response parameters are present in the

parameters table.

Error Response Parameters

The error response parameters are available in the


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 Android 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.

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

razorpay.getPaymentMethods(new PaymentMethodsCallback() {
public void onPaymentMethodsReceived(String result) {
JSONObject paymentMethods = new JSONObject(result);
public void onError(String error){

Check the various

available with Razorpay Android Custom SDK.

Handy Tips

If you are using Subscriptions, you can pass the subscription_id in the options, which fetches subscription-related details along with the payment method. This saves you a network call to get amount for that subscription_id. Know more about


The bank ACS pages are displayed to the user in a WebView. You need to define a WebView in your layout and pass the reference to our SDK using setWebView, as shown below:

webview = findViewById(R.id.payment_webview);
// Hide the webview until the payment details are submitted

Once you have received the customer's payment information, it needs to be sent to our API to complete the creation step of the payment flow. You can do this by invoking submit method. Before invoking this method, you have to make your webview visible to the customer. The data that needs to be submitted in the form of a JSONObject is shown below:

try {
JSONObject data = new JSONObject();
data.put("amount", 50000); // pass in currency subunits. For example, paise. Amount: 1000 equals ₹10,
data.put("currency", "INR"); // pass the currency code. For example, INR.
data.put("order_id", "order_DgZ26rHjbzLLY2");//sample order_id. Generate orders using Orders API
data.put("email", "gaurav.kumar@example.com");
data.put("contact", "9876543210");
JSONObject notes = new JSONObject();
notes.put("custom_field", "abc");
data.put("notes", notes);
data.put("method", "netbanking");
// Method specific fields
data.put("bank", "HDFC");
// Make webview visible before submitting payment details
razorpay.submit(data, new PaymentResultListener() {
public void onPaymentSuccess(String razorpayPaymentId) {
// Razorpay payment ID is passed here after a successful payment
public void onPaymentError(int code, String description) {
// Error code and description is passed here
} catch (Exception e) {
Log.e(TAG, "Error in submitting payment details", e);

Below is a complete list of Checkout form parameters:


integer Integer value in currency subunits. For example, for ₹299.35 , amount should be 29935.


string Defaults to INR. We support payments in

as well.


string Unique identifier of the order generated using



string Email address of the customer. For example, gaurav.kumar@example.com .


string Phone number of the customer. For example, 912345678, +18002700323.


string The method used to make the payment. Possible values:

  • card
  • netbanking
  • wallet
  • emi
  • upi
  • app


array The following card details have to be provided when card is selected as the payment method.


string Unformatted card number. Required when the payment method is card. For example, 4242424242424242.


string The name of the cardholder.


integer Expiry month for card in MM format.


integer Expiry year for card in YY format.


integer CVV printed on the back of the card.

Handy Tips

  • CVV is not required by default for Visa and Amex tokenised cards.
  • To enable CVV-less flow for Rupay and MasterCard, contact our .
  • CVV is mandatory for Diners tokenised cards.
  • CVV is an optional field. Skip passing the cvv parameter to Razorpay to implement this change.


integer Defines the number of months in the EMI plan. To be provided only if the payment method selected is emi.


string Bank code. To be provided if value of method field is netbanking. For example, SBIN. You can retrieve the list of supported bank codes using the



string Wallet code. To be provided if value of method field is wallet such as mobikwik. You can retrieve the list of supported wallets using the



string The virtual payment address of the customer. This value can be a text field with regex of ^.+@.+$. This field is only valid when _[flow] is collect and is not required if _[flow] is intent


The upi method can have two flows, collect and intent. Defaults to collect. Refer to the

for more details.


Package name of the UPI app you want to launch. This is only valid when _[flow] is intent and is not required if _[flow] is collect. This is an optional field and all UPI apps will be displayed if not value specified.


mandatory if method=app

string Name of the PSP app. For example, cred.


mandatory if app=cred

boolean Determines the payment flow - collect or intent. Possible values:

  • true: Opens CRED app on customer's device.
  • false (default): Sends a push notification to customer's device.


json object Optional key-value pair represented as JSON object. You can also add up to 15 "notes" custom fields, which are associated with this payment and returned to you while fetching payment details from API.

Handy Tips

To reuse the Razorpay Checkout web integration inside a web view on Android or iOS, pass a

along with other checkout options to process the desired payment.

You have the option to implement PaymentResultListener or PaymentResultWithDataListener to receive callbacks for the payment result.

  • PaymentResultListener provides only payment_id as the payment result.
  • PaymentResultWithDataListener provides additional payment data such as email and contact of the customer, along with the order_id, payment_id, signature and more.
razorpay.submit(data, new PaymentResultWithDataListener() {
public void onPaymentSuccess(String razorpayPaymentId, PaymentData paymentData) {
// Razorpay payment ID and PaymentData passed here after a successful payment
public void onPaymentError(int code, String description) {
// Error code and description is passed here
} catch (Exception e) {
Log.e(TAG, "Error in submitting payment details", e);

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.


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.

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 .
  2. Use the SHA256 algorithm, the razorpay_payment_id and the order_id to construct a HMAC hex digest as shown below:

    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.

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);

After you have completed the integration, you can

, make test payments, replace the test key with the live key and integrate with other .

You can track the payment status in three ways:

Handy Tips

  • On the Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to .
  • Subscribe to our webhooks or poll the Fetch a Payment API to track the payment status.

To verify the payment status from the Dashboard:

  1. Log in to the and navigate to TransactionsPayments.
  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.
Check if the payment id is generated and the status is captured

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

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

to check the payment status.

Is this integration guide useful?