1. Build Integration
Install and configure the OpenCart plugin.
2. Test Integration
Test the integration by making a test payment.
3. Go-Live Checklist
Check the go-live checklist.
1. Build Integration
Follow the steps given below:1 Install Plugin
1 Install Plugin
- Download the latest Source code zip file of the required version of the plugin.
- Download the latest release of the OpenCart 4 plugin from the Releases section in GitHub. Tags for OpenCart 4 are opencart4-6.x.y.
- Download the latest release of the OpenCart 3 plugin from the Releases section in GitHub. Tags for OpenCart 3 are opencart3-1.x.y.
- For OpenCart 2, download this release from GitHub. Tags for OpenCart 2 are opencart2-3.x.y.
- For OpenCart 1.5, download this release from GitHub. Tags for OpenCart 1.5 are opencart1.5-1.x.y.
- Navigate to Extensions → Installer and click Upload. Choose the zip file.
2 Configure OpenCart
2 Configure OpenCart
Configure OpenCart as given below:
- Log in to OpenCart.
- Navigate to the Admin Panel → Extensions → Payments to install the Razorpay Payment Gateway extension.
- Click Edit. Complete the following steps:
- Add in your Key_ID and Key_Secret generated from the Razorpay Dashboard.
- Change extension status to Enabled.
- Click Save to save the extension settings.
Handy TipsWebhook is auto-configured on OpenCart 3 (versions 5.0.0 and above) and OpenCart 4 when you enter and save the API key ID and secret on the plugin settings page. You need to verify if webhooks are enabled on your Razorpay Dashboard.
However, for versions lower than 5.0.0, you must configure webhooks manually.
However, for versions lower than 5.0.0, you must configure webhooks manually.
Create Cron for OpenCart 3
Create a Cron for Webhook using cpanel, follow the steps given below:- Log on to your cPanel Interface.
- Go to Advanced section.
- Click Cron Jobs.
- Select the specific time from the lists provided (every 5 minutes).
- Enter
https://<shop_url>/index.php?route=extension/payment/razorpay/rzpWebhookCron/in the Command field.
2. Test Integration
After the integration, Razorpay will appear as a payment option on your webpage/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.
Supported Payment Methods
Supported Payment Methods
After the integration is complete, a Pay button appears on your webpage/app.Click the button and make a test transaction to ensure the integration is working as expected. You can start accepting actual payments from your customers once the test transaction is successful.Following are all the payment modes that the customer can use to complete the payment on the Checkout. Some of them are available by default, while others may require approval from us. Raise a request from the Dashboard to enable such payment methods.
You can make test payments using one of the payment methods configured at the Checkout.
FPX
FPX
You can select any of the listed banks. After choosing a bank, Razorpay Curlec will redirect to a mock page where you can make the payment a
success or a failure. Since this is Test Mode, we will not redirect you to the bank login portals.Wallet
Wallet
You can select any of the listed wallets. After choosing a wallet, you will be redirected 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.Cards
Cards
You can use one of the following test cards to test transactions for your integration in Test Mode.
Check the following lists:
Verify Payment Status
Verify Payment Status
You can track the payment status from the Dashboard or by polling APIs.
- Verify Payment Status From Dashboard
- Poll APIs
- Log in to the Razorpay Dashboard 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.
3. Go-live Checklist
Follow these steps before taking the integration live:1 Accept Live Payments
1 Accept Live Payments
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.To generate API Keys in Live Mode on your Razorpay Dashboard:
- Log in to the Razorpay Dashboard 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.
2 Payment Capture
2 Payment Capture
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.- Auto-capture Payments (Recommended)
- Manually Capture Payments
Authorized payments can be automatically captured. You can auto-capture all payments using global settings on the Razorpay Dashboard. Know more about capture settings for payments.