1. Build Integration

Follow the step-by-step guide on how to integrate the Razorpay Payment Gateway with your Magento 1.x and 2.x Extensions.


Follow the steps given below to integrate Razorpay Payment Gateway with your Magento 1.x and 2.x Extensions.

Integration Steps for Magento 1.x Extension🔗

  1. Download and Install via Repository.
  2. Configure Magento Store 1.x.

Step 1: Download and Install via Repository🔗

Download the Required Repository🔗

  1. Download the Razorpay-1.1.31.tgz file from the latest release.

  2. If you have Onepage Checkout (IWD or Fire Checkout), download the Source Code zip from the latest release. With Onepage Checkout you can gather the required information from the shopper and complete the checkout process quickly. When Onepage Checkout is enabled, the entire checkout process takes place on a single page.

Install the Repository🔗

Install via Magento Connect🔗

  1. Go to Magento Connect Manager.
  2. Go to Direct package file upload.
  3. Click on Choose File and select the tgz file from Step 1.
  4. Click on upload.

Install without Magento Connect🔗

  1. Unzip and open the downloaded folder.
  2. Copy the app folder.
  3. Paste and merge it into the Magento root folder.
  4. Copy the js folder.
  5. Paste and merge it into the Magento root folder.

Once installed, navigate to Configuration and then to Payment Gateways and configure the extension to suit your needs.

Step 2: Configure Magento Store 1.x🔗

To configure your Magento store for Razorpay:

  1. Log into your Magento store.

  2. Click on the System tab and then select Configuration option from the drop-down list.

  3. Click Payment Methods in the menu panel.

  4. Scroll down. Click Razorpay, and enter your test mode [KEY_ID] and <KEY_SECRET>.

  5. Select Yes for the Enabled option.

  6. Click Save Config button. This activates your account in the Test Mode. You can use this account to make a few test payments to ensure a successful workflow. Handy Tips
    In test mode, no real money is deducted from your account.

Integration Steps for Magento 2.x Extension🔗

  1. Download and Install Extension.
  2. Configure Magento Store 2.x.
  3. Set Up Webhooks.

Step 1: Download and Install Extension🔗

Install Using Composer🔗

  1. Install the extension on your Magento store using the Composer Package Manager. Composer is an application-level package manager for the PHP programming language that provides a standard format for managing dependencies of PHP software and required libraries.

  2. Go to your installation root directory of Magento and execute the following command:

    Copycomposer require razorpay/magento bin/magento module:enable Razorpay_Magento
  3. You can check if the installation was successful by executing the following command in the Magento root directory.

    Copybin/magento module:status

    Handy Tips
    You should see Razorpay_Magento in the status. It might appear on the disabled modules list.

  4. Enable and deploy the Razorpay module using commands:

    Copybin/magento module:enable Razorpay_Magento bin/magento setup:upgrade bin/magento setup:static-content:deploy

Upgrade Magento Extension
If you are an existing user of this extension, you can upgrade to the the latest version using composer.

Install Without Composer🔗

  1. Download the code.zip file from the latest release. Extract the zip.

  2. Place the code folder from Step 1 in your app folder. If you're performing an update, replace/overwrite the existing code folder.

  3. Enable and deploy the Razorpay module using commands:

    Copybin/magento module:enable Razorpay_Magento bin/magento setup:upgrade
  4. Import the SQL file (razorpay_sales_order.sql) into your project database.

Step 2: Configure Magento Store 2.x🔗

To configure your Magento store for Razorpay:

  1. Log into your Magento store.

  2. Choose Stores on the Admin sidebar to the left. Now go to Settings > Configuration.

  3. In the Configuration page, click on Sales on the left and choose Payment Methods.

  4. In the Payment Methods page, navigate to Razorpay.

  5. Enter your test mode [KEY_ID] and [KEY_SECRET]. These can be generated from your Dashboard.

  6. Select Yes for the option Enabled.

  7. Click Save Config. This activates your account in the Test Mode. You can use this account to make a few test payments to ensure a successful workflow. Handy Tips
    In test mode, no real money is deducted from your account.

Step 3: Set Up Webhooks🔗

Webhooks are triggered when certain events occur. Subscribe to webhook events to receive notification (in the form of a webhook payload) when these events occur.

Setting up webhooks makes your integration more robust, and guards against issues arising from poor connectivity. The webhook URL is available on the plugin's settings page. You must copy it from there and use it to set up webhook on the Razorpay Dashboard.

Handy Tips
If you are using Magento plugin version 3.4.1, ensure the webhook delay is set to a minimum 300 seconds.

To set up webhooks in the Razorpay Dashboard:

  1. Log into the Razorpay Dashboard.
  2. Navigate to SettingsWebhooks.
  3. Click + Add New Webhook.
  4. In the Webhook Setup modal:
    • Paste the URL copied from the Magento site. Handy Tips
      Webhooks can only be delivered to public URLs. If you attempt to save a localhost endpoint as part of a webhook set-up, you will notice an error. Please refer to the test webhooks section for alternatives to localhost.
    • Enter the Secret you had provided on the Magento site. The secret is used to validate that the webhook is from Razorpay. Do not expose the secret publicly. Know more about webhooks validation.
    • In the Alert Email field, enter the email address to which notifications must be sent in case of webhook failure.
    • Select only the order.paid event from the list of Active Events.
  5. Click Create Webhook.

Know more about webhooks.

Verify Payment Status🔗

You can track the payment status from the Razorpay Dashboard, subscribe to the Webhook event or poll our APIs.

Verify Payment Status From Dashboard🔗

  1. Log into the 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.

Subscribe to Webhook events🔗

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 set up Webhooks.

Example🔗

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

Poll APIs🔗

Poll Payment APIs to check the payment status.

×