Skip to main content
Follow these steps to integrate your Android application with Razorpay Android Custom SDK: 1.1 Install Razorpay Android Custom SDK.
1.2 Instantiate and Initialise Razorpay Android Custom SDK.
1.3 Create an Order in Server.
1.4 Fetch Payment Methods.
1.5 Set Up WebView.
1.6 Submit Payment Data and Handle Success and Error Events.
1.7 Store Fields in Your Server.
1.8 Verify Payment Signature.
1.9 Verify Payment Status.

1.1 Install 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.
Java
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.
Handy TipsFrom version 3.9.22 onwards, the latest version is automatically updated, eliminating the need for manual updates.

1.2 Instantiate and Initialise Razorpay Android Custom SDK

Instantiate

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

Proguard Rules

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

Initialise

Add your API keys 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.

Sample Code

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
Handy TipsThe auto-OTP reading feature is available only for saved cards. Know more about saved cards.
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:

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.
Watch Out!Payments made without an order_id cannot be captured and will be automatically refunded. You must create an order before initiating payments to ensure proper payment processing.

API Sample Code

Use this endpoint to create an order using the Orders API. POST /orders
amount mandatory : integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of , the value of this field should be 22225.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 is 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.
first_payment_min_amount optional : integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of is to be received from the customer in two installments of #1 - RM 5,000, #2 - RM 2,000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.
Descriptions for the response parameters are present in the Orders Entity parameters table.
The error response parameters are available in the API Reference Guide.

1.4 Fetch Payment Methods

You can accept payments through wallets, FPX, credit and debit cards 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.

Sample Code

The following is an API used to fetch all enabled payment methods for a given API Key ID:
Payment Methods API
Check the various payment methods available with Razorpay Android Custom SDK.

1.5 Set Up WebView

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:

1.6 Submit Payment Data and Handle Success and Error Events

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.
Below is a complete list of Checkout form parameters: key mandatory : string API Key ID 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. description optional : string Description of the product shown in the Checkout form. It 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 the Orders API. 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). method mandatory : string The payment method used by the customer on Checkout.
Possible values:
  • card (default)
  • fpx (default)
  • wallet (default)
card mandatory if method=card : object The details of the card that should be entered while making the payment. number : integer Unformatted card number. name : string The name of the cardholder. expiry_month : integer Expiry month for card in MM format. expiry_year : integer Expiry year for card in YY format. cvv : integer CVV printed on the back of the card. bank mandatory if method=fpx : string Bank code. List of available banks enabled for your account can be fetched via methods. wallet mandatory if method=wallet : string Wallet code for the wallet used for the payment. Possible values:
  • touchngo (default)
  • grabpay (default)
  • shopback (requires approval)
callback_url optional : string Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is whitelisted. This parameter is mandatory for FPX payments. redirect optional : boolean Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. callback_url and redirect parameters are mandatory for FPX payments. Possible values:
  • true: Customer is redirected to the specified callback URL in case of payment failure. For FPX payments, the redirect parameter should always be sent as true.
  • false (default): Customer is not redirected to the specified callback URL.
Handy TipsTo reuse the Razorpay Checkout web integration inside a web view on Android or iOS, pass a callback_url along with other checkout options to process the desired payment.

Use PaymentResultWithDataListener

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.

1.7 Store Fields in Your 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.

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.

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.
  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:
HMAC Hex Digest
  1. 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:
After you have completed the integration, you can set up webhooks, make test payments, replace the test key with the live key and integrate with other APIs.

1.9 Verify Payment Status

Handy TipsOn the Razorpay Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to capture payments automatically.
To verify the payment status from the Razorpay Dashboard:
  1. Log in to the Razorpay Dashboard 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.
Payment details on Dashboard

Next Steps

Step 2: Test Integration