API ReferenceIntegrationsKnowledge Base

Web Integration - Razorpay Custom Checkout

With Custom Checkout, you can build a checkout form to suit your unique business needs and branding guidelines.

Custom Checkout's JavaScript library lets you customize the checkout interface on a granular level. For example, you can white-label the checkout to:

Payments accepted from registered websites only:
You can accept payments only from those websites that you had registered with us at the time of signing up for an account. All payments received on the unregistered websites are failed by Razorpay. If you want to accept payments from multiple websites, contact our support team to register additional websites for your account.

Prerequisites#

Before integrating with the Checkout, run through this checklist:

PCI DSS Certification:
A customer's payment information should never reach your servers, unless you are PCI DSS certified.

Integration Steps#

Steps to integrate Custom Checkout in your site:

  1. Create an Order in your Server.
  2. Fetch Payment Methods.
  3. Invoke Checkout and Pass Order Id and Other Options to it
    1. Include the JavaScript code in your Webpage.
    2. Instantiate Razorpay Custom Checkout.
    3. Submit Payment Details.
  4. Store Fields in your Server.
  5. Verify the Signature.

Step 1: Create an Order in 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: Fetch Payment Methods#

When creating a custom checkout form, you need to ensure that only the methods that are activated for your account are displayed to the customer.

Use the below methods to fetch all payments methods available to you.

Copyvar razorpay = new Razorpay({ key: '<YOUR_KEY_ID>', // logo, displayed in the popup image: 'https://i.imgur.com/n5tjHFD.png', }); razorpay.once('ready', function(response) { console.log(response.methods); })
Copy{ "methods": { "entity": "methods", "card": true, "debit_card": true, "credit_card": true, "prepaid_card": true, "card_networks": { "AMEX": 0, "DICL": 1, "MC": 1, "MAES": 1, "VISA": 1, "JCB": 1, "RUPAY": 1, "BAJAJ": 0 }, "amex": false, "netbanking": { ... ... "HDFC": "HDFC Bank", "ICIC": "ICICI Bank" ... ... }, "wallet": { "payzapp": true, "freecharge": true }, "emi": true, "upi": true, "cardless_emi": [], "paylater": [], "emi_subvention": "customer", "emi_options": { ... ... "ICIC": [ { "duration": 3, "interest": 13, "subvention": "customer", "min_amount": 150000 }, { "duration": 6, "interest": 13, "subvention": "customer", "min_amount": 150000 } ...// rest of the emi plans ], "HDFC": [ { "duration": 12, "interest": 14, "subvention": "customer", "min_amount": 300000 }, { "duration": 18, "interest": 15, "subvention": "customer", "min_amount": 300000 } ... ...// rest of the emi plans ] } } }

Read more: Learn more about the various payment methods offered by Razorpay.

Step 3: Invoke Checkout and Pass Order Id and Other Options to it#

Step 3.1: Include the JavaScript code in your Webpage#

Include the following script, preferably in <head> section of your page:

Copy<script type="text/javascript" src="https://checkout.razorpay.com/v1/razorpay.js"></script>

Including the Javascript, not the Library:
Include the script from https://checkout.razorpay.com/v1/razorpay.js instead of serving a copy from your own server. This allows new updates and bug fixes to the library to get automatically served to your application.

We always maintain backward compatibility with our code.

Step 3.2: Instantiate Razorpay Custom Checkout#

Single Instance on a Page#

Copyvar razorpay = new Razorpay({ key: '<YOUR_KEY_ID>', // logo, displayed in the payment processing popup image: 'https://i.imgur.com/n5tjHFD.png', });

Multiple Instances on Same Page#

If you need multiple razorpay instances on same page, you can globally set some of the options:

CopyRazorpay.configure({ key: '<YOUR_KEY_ID>', // logo, displayed in the payment processing popup image: 'https://i.imgur.com/n5tjHFD.png', }) new Razorpay({}); // will inherit key and image from above.

Step 3.3: Submit Payment Details#

Once the order is created and the customer's payment details are obtained, the information should be sent to Razorpay to complete the payment. The data that needs to be submitted depends upon the payment method selected by the customer.

You can do this by invoking createPayment method:

Copyvar data = { amount: 1000, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10 currency: "INR",// Default is INR. We support more than 90 currencies. email: 'gaurav.kumar@example.com', contact: '9123456780', notes: { address: 'Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru', }, order_id: 'order_CuEzONfnOI86Ab',// Replace with Order ID generated in Step 4 method: 'netbanking', // method specific fields bank: 'HDFC' }; var btn = document.querySelector('#btn'); btn.addEventListener('click', function(){ // has to be placed within user initiated context, such as click, in order for popup to open. razorpay.createPayment(data); razorpay.on('payment.success', function(resp) { alert(resp.razorpay_payment_id), alert(resp.razorpay_order_id), alert(resp.razorpay_signature)}); // will pass payment ID, order ID, and Razorpay signature to success handler. razorpay.on('payment.error', function(resp){alert(resp.error.description)}); // will pass error object to error handler })
Copyvar data = { callback_url: 'https://www.examplecallbackurl.com/', amount: 1000, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10 currency: "INR",// Default is INR. We support more than 90 currencies. email: 'gaurav.kumar@example.com', contact: '9123456780', notes: { address: 'Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru', }, order_id: 'order_CuEzONfnOI86Ab',// Replace with Order ID generated in Step 4 method: 'netbanking', // method specific fields bank: 'HDFC' }; var btn = document.querySelector('#btn'); btn.addEventListener('click', function(){ // has to be placed within user initiated context, such as click, in order for popup to open. razorpay.createPayment(data); })

Note:
The createPayment method should be called within an event listener triggered by user action to prevent the popup from being blocked. For example:
js $('button').click( function (){ razorpay.createPayment(...) })

Handler Function vs Callback URL:

  • Handler Function:
    When you use the handler function, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Checkout Form. You need to collect these and send them to your server.
  • Callback URL:
    When you use a Callback URL, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Callback URL.

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.

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.

Integrate the Payments Rainy Day Kit#

While Razorpay strives to provide a positive payment experience to every customer, they might face payment exceptions such as:

  • Late Authorization
  • Payment Downtime
  • Payment Errors

To overcome such exceptions and provide a smooth payment experience to your customers, use the Payments Rainy Day kit.

×