Appearance
Settings reference
This is the complete list of settings on the PayGlocal Recurring gateway configuration screen, found at Setup → Payment Gateways → PayGlocal Recurring. For a guided walkthrough of filling these in and taking a test payment, see Configuration.
Where these live
Every field below is on WHMCS's native gateway page — there is no separate addon area or Settings tab. After editing any value, click Save Changes.
Gateway configuration fields
| Field | What to enter | Default |
|---|---|---|
| License Key | Your PayGlocal Recurring license key from your relyweb.co account. Payments are disabled while the license is inactive. | (empty) |
| Merchant ID (MID) | Your PayGlocal Merchant ID from onboarding. | (empty) |
| Merchant Private Key File Path | Absolute server path to your merchant RSA private key .pem file (e.g. /home/user/keys/merchant_private.pem), stored outside the web root and readable by the web-server user. | (empty) |
| Merchant Private Key ID (KID) | The Key ID (KID) of your merchant private key, from Key Management in the PayGlocal GCC dashboard. | (empty) |
| PayGlocal Public Key File Path | Absolute server path to PayGlocal's public key file (the Common Certificate you downloaded). | (empty) |
| PayGlocal Public Key ID (KID) | The Key ID (KID) of PayGlocal's public key (common certificate). | (empty) |
| SI Maximum Amount Per Payment | The cap per recurring charge, as a multiple of the first invoice amount. Dropdown 1x–5x. Charges above the mandate's maximum are skipped. | 2x |
| Days Before Due Date to Charge | How many days before an invoice's due date the daily cron attempts the auto-charge. Dropdown 1–5 days. | 2 days |
| Test / Sandbox Mode | Yes uses PayGlocal's UAT (sandbox) for testing; No is live production. Your keys/KIDs must match the environment. | No |
Notes on the recurring settings
- SI Maximum Amount Per Payment is a guardrail expressed as a multiple. At 3x, a first invoice of 100 USD allows later charges up to 300 USD; a larger invoice is skipped rather than charged.
- Days Before Due Date to Charge sets the charging window. At 2 days, an invoice due March 20 is charged on or after March 18. Automatic charges require the WHMCS daily cron to be running.
Where to see activity
This gateway records its activity in the Gateway Log at Utilities → Logs → Gateway Log — check there to confirm payments, mandate storage, and cron charges, or to diagnose a failure.
Related pages
- Configuration — the step-by-step setup walkthrough
- Licensing — how the License Key controls payment processing
- Updating — installing a new version