Integration Steps
Steps to integrate your Drupal Commerce website with the Razorpay Payment Gateway.
Follow the steps given below to integrate Razorpay Payment Gateway with your Drupal Commerce website.
Follow the steps given below:
To upload the plugin:
- the
drupal_commerce_razorpay.zip. - Log in to your and navigate to Extend.
- Click + Add new module.
- Add the module from URL or click Choose file and select the .zip file downloaded previously.
- Click Continue.
You have successfully uploaded the plugin.
Handy Tips
Alternatively, you can skip this step and simply run composer require 'drupal/drupal_commerce_razorpay:^1.0' in your drupal directory to download the plugin. You can view the downloaded file in the contrib folder.
To install the plugin:
- On your Drupal Commerce Dashboard, navigate to Extend.
- Search for Razorpay in the Filter section.
- Select Commerce Razorpay and click Install.
To configure the plugin:
- On your Drupal Commerce Dashboard, navigate to Commerce.
- Click Configuration.
- In the Payment section, select Payment gateways.
- Click + Add payment gateway.
- In the Name section, enter Razorpay and select Razorpay as the Plugin.
- Select Test Mode to test the integration and enter the test Key ID and Secret generated from the .
Handy Tips
To go live with the integration and start accepting real payments:
- Select Live Mode.
- Generate and replace the test keys with the live keys in the integration. Click Save.
- Select the Payment Action based on your requirement. Set the Payment Action to Authorize and Capture to auto-capture payments. If you want to capture payments manually, set the Payment Method to Authorize.
- Select Enabled in the Status section.
- Click Save.
Handy Tips
If you want to edit any fields, navigate to Commerce → Configuration. Select Payment Gateway and click Edit.
You have successfully integrated the Razorpay Payment Gateway with your Drupal Commerce website.
Handy Tips
- Webhooks are auto-configured when you enter and submit the API key ID during the installation. You can verify if webhooks are enabled on your .
- The
payment.authorized,payment.failedandrefund.createdevents are auto-configured. You do not have to configure it on the Razorpay Dashboard.
After the integration is complete, a payment button will appear on your web page/app. You need to click the button and make a test transaction to ensure the integration works as expected. You can start accepting actual payments from your customers once the test is successful.
Watch Out!
This is a mock payment page that uses your test API keys, test card and payment details.
- Ensure you have entered only your in the Configuration section of the Drupal Commerce Dashboard.
- As the test API key is used, no real money is deducted. This is a simulated transaction.
You can select any of the listed banks on checkout. After choosing a bank, Razorpay will redirect to a mock page where you can make the payment success or a failure. Since this is Test Mode, we will not redirect you to the bank login portals.
You can enter one of the following UPI IDs:
success@razorpay: To make the payment successful.failure@razorpay: To fail the payment.
Handy Tips
You can use Test Mode to test UPI payments, and Live Mode for UPI Intent and QR payments.
You can use one of the following test cards to test transactions for your integration in Test Mode.
- Use any valid expiration date in the future in the MM/YY format.
- Use any random CVV to create a successful payment.
You can select any of the listed wallets. After choosing a wallet, Razorpay will redirect to a mock page where you can make the payment success or a failure. Since this is Test Mode, we will not redirect you to the wallet login portals.
Currently, we support a host of currencies, including INR, USD, EUR, and SGD.
- View the complete .
- For any other additional currencies, which are not a part of the above list and that you might want us to support, kindly raise a request on our .
You can track the payment status from the Dashboard or poll our APIs.
- Log in to the and navigate to Transactions → Payments.
- Check if a
payment_IDhas been generated and note the status. In case of a successful payment, the status is marked ascaptured.
Follow these steps before taking the integration live:
You can perform an end-to-end simulation of funds flow in the Test Mode. Once confident that the integration is working as expected, switch to the Live Mode and start accepting payments from customers.
Watch Out!
Ensure you are switching your test API keys with API keys generated in Live Mode.
To generate API Keys in Live Mode on your Razorpay Dashboard:
- Log in to the and switch to Live Mode on the menu.
- Navigate to Account & Settings → API Keys → Generate Key to generate the API Key for Live Mode.
- Download the keys and save them securely.
- On your , navigate to Commerce.
- Click Configuration.
- In the Payment section, select Payment gateways.
- Click Edit.
- In the Mode section, select Live.
- Replace the Test Key ID and Secret with the Live Keys and accept actual payments.
After a payment is authorized, you must capture it to settle the amount to your bank account as per the settlement schedule.
Follow the steps given below to set a payment action:
- On the , navigate to Commerce.
- Click Configuration.
- In the Payment section, select Payment gateways.
- Click Edit.
- In the Payment Action section, you can choose to:
- Authorize and Capture: This setting captures all authorized payments automatically. This eliminates the time and effort spent manually capturing payments.
- Authorize: Each authorized payment can also be captured individually.
- Once a payment is completed, navigate to Commerce → Orders.
- Identify the order you want to capture the payment and click View.
- Navigate to Payments.
- In the Operations section, click Capture.
To initiate refunds using the Drupal Commerce Dashboard:
- Log in to the .
- After a payment is completed, navigate to Commerce → Orders.
- Identify the order you want to initiate a refund and click View.
- Navigate to Payments.
- In the Operations section, click Refund.
- You can either issue a full refund or a partial refund.
- For a full refund, enter the entire payment amount.
- For a partial refund, enter a value lesser than the payment amount.
- Click Refund.
Is this integration guide useful?