API ReferenceIntegrationsKnowledge Base

Quick Integration

You can use the automatic checkout method (Quick Integration) for quickly integrating Razorpay Gateway with your website and start accepting payments.

Quick Integration vs Standard Integration🔗

Handy Tips
The Quick Integration (also known as Automatic checkout method) is simple and fast. However, in case you would like more control over your integration, we recommend the Manual checkout method (Standard Integration) for integrations. Given below is a comparison between the Standard (Manual) and Quick (Automatic) checkout integrations.

Particulars

Quick Integration

Standard Integration

Pay Button

The pay button is auto-created. It cannot be customised. For example, you cannot change its font or background colour.

You can create and customise the pay button as per your business requirements.

Checkout Functions

This is an HTML-based form action method. You cannot use any JavaScript function to make any customisations.

This is a JavaScript method. You can use additional functions to automatically open and close Checkout as required.

Integration Steps🔗

  1. Create an Order from your Server.
  2. Pass Order ID and Other Options to the Checkout.
  3. Store the fields in your Database.
  4. Verify the Signature.

Post-Integration Steps
Once you have successfully completed the integration, you can set up 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 from your Server🔗

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

/orders
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 2: Pass Order ID and Other Options to the Checkout🔗

The Standard Automatic Checkout method provides a default Razorpay Pay with Razorpay button that invokes the Checkout form. The checkout form options are passed as data attributes inside a <script> tag. You can add any additional, hidden or visible fields to the form, which will be submitted along with the form.

The following sample code will pass the Razorpay Checkout options as HTML data attributes:

Copy<form action="https://www.example.com/payment/success/" method="POST"> <script src="https://checkout.razorpay.com/v1/checkout.js" data-key="YOUR_KEY_ID" // Enter the Test API Key ID generated from Dashboard → Settings → API Keys data-amount="29935" // Amount is in currency subunits. Hence, 29935 refers to 29935 paise or ₹299.35. data-currency="INR"// You can accept international payments by changing the currency code. Contact our Support Team to enable International for your account data-order_id="order_CgmcjRh9ti2lP7"// Replace with the order_id generated by you in the backend. data-buttontext="Pay with Razorpay" data-name="Acme Corp" data-description="A Wild Sheep Chase is the third novel by Japanese author Haruki Murakami" data-image="https://example.com/your_logo.jpg" data-prefill.name="Gaurav Kumar" data-prefill.email="gaurav.kumar@example.com" data-theme.color="#F37254" ></script> <input type="hidden" custom="Hidden Element" name="hidden"> </form>

Only successful authorizations are auto-submitted. For each successful payment, the checkout returns the following:

  • razorpay_payment_id
  • razorpay_order_id
  • razorpay_signature

In case of failed payments, the customer is prompted to retry the payment on the Checkout Form.

Checkout Options

data-key mandatory
string The API Key ID generated by you via the Razorpay Dashboard. For example, rzp_test_SfP9effnec4ntR.
data-amount mandatory
integer The amount to be paid by the customer. This must be in currency subunits. That is, if the amount is ₹299.35, enter the value as 29935.
data-currency mandatory
string The currency in which the payment should be made by the customer. See the list of supported currencies.
data-order_id mandatory
string Unique identifier of the Order generated in Step 1: Create an Order in your Server.
data-buttontext mandatory
string The text you want to display on the button. For example, Buy Now!.
data-name mandatory
string The business/company name shown in the Checkout form. For example, Acme Corp.
data-description optional
string Description of the purchase item shown in the Checkout form. Must start with an alphanumeric character.
data-image mandatory
string Link to an image (usually merchant's logo) shown in the Checkout form. It can also be a base64 string, if loading the image from a network is not desirable.
data-prefill.name optional
string Cardholder's name to be pre-filled when the Checkout opens.
data-prefill.email optional
string Customer's email to be pre-filled when the Checkout opens. For example, gaurav.kumar@example.com.
data-prefill.contact optional
string Customer's phone number to be pre-filled when the Checkout opens.
data-theme.color optional
string Brand color to alter the appearance of Checkout form. For example, #F37254.

Know more about the complete list of checkout options available.

Step 3: Store the fields in your Database🔗

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 4: 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 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

.Net

https://github.com/razorpay/razorpay-dot-net

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)
Copy Dictionary<string, string> attributes = new Dictionary<string, string>(); attributes.Add("razorpay_payment_id", paymentId); attributes.Add("razorpay_order_id", Request.Form["razorpay_order_id"]); attributes.Add("razorpay_signature", Request.Form["razorpay_signature"]); Utils.verifyPaymentSignature(attributes);

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.

Payment Capture Settings🔗

After a payment is authorized, you need to capture the payment made by the customer for the amount 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.

  • Auto-capture payments (recommended)
    Authorized payments can be automatically captured. You can auto-capture all payments using global settings on the Razorpay Dashboard.
  • Manually capture payments
    Each authorized payment can also be captured individually. You can manually capture payments:

Know more about Capture Settings for payments.

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

Other Integration Methods🔗

Looking to integrate Razorpay with your mobile app or at a server-level? Following are the other integration methods available:

Web Integration

  • Standard Checkout Integration


  • Gravity Forms

  • Gravity Forms


  • Mobile Integration

  • Android Standard Checkout Integration

  • iOS Standard Checkout Integration

  • Cordova SDK Integration

  • React Native SDK Integration

  • Flutter SDK Integration


  • Ecommerce Plugins

  • Arastta Integration

  • CS-Cart Integration

  • Easy Digital Download Integration

  • Magento Integration

  • OpenCart Integration

  • PrestaShop Integration

  • Shopify Integration

  • WHMCS Integration

  • Wix Integration

  • WooCommerce Integration

  • WordPress Integration


  • Server Integrations (Languages)

  • PHP Integration

  • Ruby Integration

  • Python Integration

  • NodeJS Integration

  • .NET Integration

  • Java Integration

  • Go Integration

  • ×