Razorpay Payment

Take UPI, card, netbanking and wallet payments for ShopClass shop orders and credit packages through Razorpay Standard Checkout. Buyers pay in Razorpay's own window, so no card data reaches your site. Core adds the credits or marks the shop order paid once the payment is confirmed.

Requirements

• ShopClass 7.0.0 or later, with billing turned on
• PHP 8.0 or later, with the curl extension
• Cron running, for retries and the daily check of pending orders

Works on plain shared hosting: no shell, worker or Redis is needed. On a VPS with core's job worker, retries just run sooner.

Install

From the admin: Plugins → Manage plugins → Browse, find Razorpay Payment, then Install and activate it. Or upload the zip under Plugins → Add new.

Settings

1. Open Settings → Billing → Payment methods and choose Set up next to Razorpay Payment.
2. In the Razorpay dashboard, switch to test mode, open Accounts & Settings → API keys and make a key. Copy the key id (rzp_test_…) and the key secret into the test fields.
3. Open Accounts & Settings → Webhooks, add a webhook with the URL the settings page shows:

   https://example.com/index.php?page=billing&action=callback&gateway=razorpay

   set a secret, and select these events:

• payment.authorized
• payment.captured
• order.paid
• payment.failed
• refund.processed

4. Type the same webhook secret into Test webhook secret and save.
5. Turn on automatic capture under Accounts & Settings → Payment capture. If a payment still arrives only authorized, the plugin captures it when the amount matches the order.

Razorpay shows at checkout once the key id and key secret for the active mode are set and the site's billing currency is one Razorpay takes. Live mode also needs the webhook secret. In test mode it is optional, so a local site Razorpay cannot reach still works: the buyer's return settles the payment.

The Currencies setting lists the codes Razorpay is offered for, such as INR, USD. Leave it empty to use the billing currency. A list that leaves out the billing currency hides Razorpay at checkout. Any currency but INR needs international payments turned on in your Razorpay account.

Saved secrets are never shown again. Leave a secret's box blank to keep it.

Test mode

The plugin starts in test mode, and an admin notice says so. In test mode only a signed-in admin sees Razorpay at checkout, so a live site cannot give credits away. Pay with Razorpay's test cards and UPI ids.

To go live, make live keys, add a second webhook in live mode with the same URL and events, fill in the live fields, then switch Mode to Live.

How an order is paid

• At checkout the plugin creates a Razorpay order for the exact amount and sends the buyer to a pay page on your site. That page alone loads Razorpay's checkout.js.
• When the payment succeeds, the page posts Razorpay's signature back. The plugin checks it, fetches the payment from Razorpay and settles the order, so the buyer sees "Paid" at once.
• The webhook settles it too, for a buyer who closes the tab.
• A failed attempt leaves the order open, so the buyer can try another method.
• If the site cannot record a payment, it is queued and fetched again later, and Razorpay resends the webhook. If it still fails, the site's contact address gets an e-mail.
• Once a day, pending Razorpay orders over an hour old are checked with Razorpay. One left unpaid for two days is closed.

A webhook is only a trigger: the plugin fetches the payment from Razorpay before acting, so an old retried webhook cannot pay an order that was since refunded. A payment for an order already closed (failed or cancelled) is refunded at Razorpay at once. If Razorpay took money the site cannot credit otherwise, or refuses that refund, the contact address gets one e-mail for that payment.

Every path goes through core's billing checks: amount, currency and owner must match, and a replayed webhook credits nothing.

The pay page needs JavaScript. Without it the buyer is told to turn it on.

Refunds

Open the order under Billing → Orders and press Refund. The plugin refunds the whole payment at Razorpay and core takes the credits back. If Razorpay is still processing the refund, the order changes once the refund.processed webhook arrives. A full refund made in the Razorpay dashboard is recorded the same way. Partial refunds change nothing on the site.

Several sites, one Razorpay account

Each site only acts on payments for Razorpay orders it created, so several sites can share an account. Give each site its own webhook.

What it stores

The keys and mode are preferences in the razorpay section. An order keeps the Razorpay references it needs in its meta. Retries and the daily check are jobs in core's job queue. No table of its own.

Hooks

Registers the gateway on register_payment_gateways, adds the pay and return pages, and listens to register_jobs, cron_daily and job_gave_up. It fires no hooks.

Uninstall

Uninstalling removes the plugin's settings, keys included. Orders, payments and credits stay in Billing → Orders. Remove the webhook in the Razorpay dashboard too.

Translations

Copy languages/razorpay.pot to languages/<locale>/messages.po, translate it, and compile it to messages.mo in the same folder. After changing strings, run php tools/make-pot.php.

What's new in 0.1.5

Changed

• A refund Razorpay is still processing shows as sent, not as an error, on ShopClass 7.1.
• A refused API call shows Razorpay's code, reason, source, step and field next to its message, and the whole error goes to the PHP error log.
• On ShopClass 7.0 Razorpay is offered for credit packages only when it takes the billing currency.
• Razorpay is offered for shop orders in INR whatever the billing currency; an empty Currencies setting now means INR and the billing currency.
• On ShopClass 7.0 the settings page stays reachable from the plugin list, since 7.0 has no Billing menu for plugin pages.
• On ShopClass 7.0 the daily check of pending orders is skipped instead of failing.
• In test mode Razorpay is offered with only the key id and secret; live mode still needs the webhook secret.
• The settings page moves under Billing.
• Test mode also shows at checkout for a signed-in admin on themes that pay through the API (ShopClass 7.1).
• A payment for an order already closed (failed or cancelled) is refunded at Razorpay instead of only e-mailing the admin.

Found a problem with Razorpay Payment? Open an issue on GitHub.