Installation

This walkthrough takes you from an empty install to a working checkout: upload the files, activate the addon, license it, connect a provider, turn on the checkout options your customers see, and set the rules that pick a provider for each payment. Confirm your server meets the Requirements first.

Step by step

1. Upload the files. Copy the modules/addons/relypay/ directory into your WHMCS installation, so it sits alongside your other addon modules.

2. Activate the addon. In the WHMCS admin, go to Setup → Addon Modules, find RelyPay in the list, and click Activate.

   Setup → Addon Modules

   Activation sets everything up for you: it creates RelyPay's database tables, generates the 10 sub-gateway checkout options, and installs the pieces that receive payment results from your providers. On success you will see:

   Activation message

   "RelyPay activated successfully. 10 sub-gateways created. Configure providers in Addons → RelyPay."

3. Enter your license key. Open Addons → RelyPay → Global Settings → License Information and enter your key. See Licensing for what each license type grants and what happens if it lapses.

4. Connect a provider. Go to Addons → RelyPay → Providers, pick a provider, and fill in its credentials. Use Test Connection to confirm the details are correct, then enable it. You can connect one provider now and add more later — see Configuration for the exact fields each provider needs and the webhook URL to paste into its dashboard.

5. Enable the sub-gateways you want. The checkout options your customers see are real WHMCS payment gateways. Turn on the ones you want under Setup → Payment Gateways, exactly like any other gateway.

   Setup → Payment Gateways

   There are 10 in total — method-specific options like RelyPay — UPI and RelyPay — Cards, plus two catch-all Default gateways. Pick the mix that matches how you want checkout to look. See Sub-gateways for what each one shows.

6. Set your routing rules. Finally, open Addons → RelyPay → Routing to decide which provider actually takes each payment — by currency, amount, or a percentage split, with a fallback so checkout keeps working if one provider is misconfigured. See Routing for the four layers and the order they are evaluated in.

You are live

Once at least one provider is connected, one or more sub-gateways are enabled, and routing is set, RelyPay is ready. Place a small test order to confirm a payment flows through and appears under Addons → RelyPay → Transactions.

Sensible starting point

Connect a single provider, enable the two Default sub-gateways (domestic and international), and leave routing on its seeded fallback. That gives you a working checkout in minutes; refine routing and add sub-gateways once you have confirmed a payment.