Integration Steps
Steps to integrate your WHMCS website with Razorpay Payment Gateway.
Follow the steps given below to integrate Razorpay Payment Gateway with your WHMCS website.
Follow the steps given below:
- Ensure you have installed the latest version of WHMCS.
- Download the Source code zip file of the required version of the plugin from the Releases section in GitHub.
- If you are using WHMCS 5, download the release tagged .
- If you are using WHMCS 6, 7 or 8, download the release tagged .
- Unzip and upload the repository contents to your WHMCS Installation directory. That is, the contents of the module folder from the repository go into the module folder of your WHMCS Installation directory.
- Log in to your site as the WHMCS administrator. This is done by adding
/adminto the URL where you have installed WHMCS, for example,www.example.com/whmcs/admin. - Navigate to Setup → Payments → Payment Gateways.
- Select Razorpay from the drop-down list and Activate it.
- Enter the [KEY_ID] and [KEY_SECRET]. You can generate these from your .
- Set Convert for Processing to INR if your store has a different default currency. In this case, update the Exchange Rate in your currency management settings.
- Click Save Changes.
To receive webhook notifications, you should configure webhooks on your WHMCS site and the Razorpay Dashboard.
To set up webhooks in the WHMCS site:
- Log in to your site as the WHMCS administrator.
- Navigate to System Settings → Payment Gateways.
- Click Manage Existing Gateways.
- Select the Enable Webhook option.
- Copy the URL that appears on the screen. In the Razorpay Dashboard, configure this URL in Settings → Webhooks. Know more about how to .
- Enter the secret.
After the integration, a Pay 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.
You can make test payments using one of the payment methods configured at the Checkout.
- No money is deducted from the customer's account as this is a simulated transaction.
- Ensure you have entered the API keys generated in the test mode in the Checkout code.
You can select any of the listed banks. After choosing a bank, Razorpay will redirect to a mock page where you can make the payment a success or a failure. Since it is the 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 select any of the listed wallets. After choosing a wallet, Razorpay will redirect to a mock page where you can make the payment a success or a failure. Since it is the test mode, we will not redirect you to the wallet login portals.
You can use one 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.
Handy Tips
On the Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to
You can track the payment status in three ways:
To verify the payment status from the Dashboard:
- Log in to the and navigate to Transactions → Payments.
- Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.
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.
- Replace the Test API Key with the Live Key in the Checkout code and start accepting actual payments.
After payment is authorized, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.
Watch Out
- You should deliver the products or services to your customers only after the payment is captured. Razorpay automatically refunds all the uncaptured payments.
- You can track the payment status using our or webhooks.
Authorized payments can be automatically captured. You can auto-capture all payments
on the Razorpay Dashboard. Know more about .Watch Out!
Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the
.Is this integration guide useful?