Installation

Installing PayGlocal for WHMCS is a short, ordered job: upload the module files, put your RSA keys somewhere safe, activate the gateway on WHMCS's native payment-gateways page, fill in the settings, and confirm it works with a sandbox test payment before you go live. Follow the steps in order — the keys need to be in place before you activate and configure.

Before you start

Have your PayGlocal keys generated and downloaded, and your Merchant ID (MID) and License Key to hand. Check the Requirements first.

Step 1 — Upload the module

Upload the module's modules/ directory into your WHMCS root, letting it merge with the existing structure. This adds the PayGlocal gateway files alongside your other gateways without touching anything else.

Your WHMCS root — merge the module's modules/ directory in

Step 2 — Place your RSA keys outside the web root

Upload your two .pem key files — your merchant private key and PayGlocal's public key — to a directory that sits outside your web root (so they can never be served over the web). Set their permissions with chmod 640 so only the web-server user can read them.

Keep private keys out of the web root

Never place a private key anywhere under public_html/httpdocs. A directory like /home/user/keys/ is a good home. You will point the gateway at each file by its absolute path.

Step 3 — Activate the gateway

In the WHMCS admin, go to Setup → Payment Gateways → All Payment Gateways, find PayGlocal in the list, and click Activate. The gateway installs the small JWT/crypto libraries it needs automatically the first time you activate it.

Setup → Payment Gateways → All Payment Gateways → PayGlocal → Activate

Step 4 — Fill in the settings

Activating opens the PayGlocal configuration form under Setup → Payment Gateways → PayGlocal. Enter your License Key, Merchant ID (MID), the path and KID for each of your two keys, and leave Test / Sandbox Mode set to Yes for now. The Configuration and Settings reference pages explain every field.

Step 5 — Save

Click Save Changes. WHMCS stores your settings and PayGlocal is now a live payment option on your invoices.

Step 6 — Take a sandbox test payment

With Test / Sandbox Mode = Yes, create a test invoice and pay it through PayGlocal end to end. Confirm the customer is redirected to PayGlocal's hosted checkout, pays, returns to WHMCS, and the invoice is marked Paid. The going-live guide walks through the switch to production once your sandbox test succeeds.

Something not right?

Open Utilities → Logs → Gateway Log — it records each payment attempt and is the fastest way to see why a test didn't complete. See Troubleshooting.

Related pages

• Requirements — confirm your server and account
• PayGlocal key setup — generate your RSA keys
• Configuration — fill in the gateway settings
• Settings reference — every field explained
• Going live — switch from sandbox to production