Skip to content

Configuration

PhonePe for WHMCS is configured on WHMCS's native gateway screen at Setup → Payment Gateways → PhonePe. This page walks through each field so you know exactly what to enter and why. For a quick lookup of defaults, see the Settings reference.

PhonePe gateway configuration fieldsSetup → Payment Gateways → PhonePe

Client ID and Client Secret

These are your PhonePe API credentials, generated in the PhonePe Merchant (Business) dashboard. The Client ID identifies your account and the Client Secret authenticates it. Copy both exactly from the dashboard — an extra space or a wrong character means PhonePe rejects the connection and payments fail.

If you don't have credentials yet, the PhonePe setup guide walks through generating them.

Keep the secret private

The Client Secret is sensitive. Only enter it in the gateway configuration; never share it or post it where others can see it.

Client Version

The Client Version tells PhonePe which API client version your integration uses. Leave it at the default of 1 unless PhonePe specifically instructs you to change it. In almost every case you never touch this field.

Payment Mode

Payment Mode controls how checkout appears to your customers:

  • Redirect (default) — the customer is sent to PhonePe's own full-page checkout, pays, and is returned to WHMCS.
  • Iframe — PhonePe's checkout opens as a popup overlay right on the invoice page, so the customer pays without leaving your site.

Both are fully supported; pick whichever suits your storefront. See Payment modes for a deeper comparison and when to choose each.

Webhook Username and Password

PhonePe confirms every payment by sending a webhook to your site, and these two fields secure that channel. Enter a Webhook Username and Webhook Password here that exactly match the username and password you set when registering the webhook in the PhonePe dashboard. The gateway uses them to authenticate each incoming notification.

The webhook URL you register in the PhonePe dashboard is:

https://yourdomain.com/modules/gateways/phonepe/webhook.php

Replace yourdomain.com with your WHMCS domain, and make sure it's reachable over HTTPS.

Both sides must match

If the username or password differs between the PhonePe dashboard and this screen, PhonePe's webhooks are rejected and invoices won't be marked paid automatically. Set them once, identically, on both sides.

Sandbox Mode

Sandbox Mode switches between PhonePe's test environment and the live one:

  • Yes — payments run against PhonePe's sandbox, so you can test the full flow without moving real money. Use this while setting up.
  • No (default) — payments are live and real money is collected.

Always confirm a sandbox payment works end to end before switching to live.

License Key

Enter your PhonePe for WHMCS License Key from relyweb.co here. The license is validated at payment time, and it gates payment processing: if the key is missing or inactive, payments are disabled until it's active again. See Licensing for how the license types work.

Save and test

After filling in the fields, click Save Changes. Then place a test order in sandbox and confirm the invoice is marked Paid. If a payment fails, check Utilities → Logs → Gateway Log — it records each step of the exchange.

Documentation for the Relyweb app catalogue.