---
url: /phonepe-whmcs/installation.md
description: >-
  Install PhonePe for WHMCS — upload the files, activate from Apps &
  Integrations, enter credentials, register the webhook, and test in sandbox
  before going live.
---

# Installation

Get PhonePe from files on disk to a working checkout: upload, activate, configure, register the webhook, test in sandbox, go live.

**Prerequisites:** a server that meets the [Requirements](/phonepe-whmcs/requirements), a WHMCS admin account, your PhonePe **Client ID** / **Client Secret** (see the [PhonePe setup guide](/phonepe-whmcs/guides/phonepe-setup)), and your PhonePe for WHMCS license key.

## 1. Upload the files

Merge the module's `modules/` directory into the root of your WHMCS install, alongside your other gateways. Nothing existing is overwritten. Updating an existing install instead? See [Updating](/phonepe-whmcs/updating).

## 2. Activate the gateway

**Apps & Integrations → PhonePe → Activate.**

![Activating PhonePe from Apps & Integrations](/phonepe-whmcs/img/phonepe-installation-activate.png)
*Apps & Integrations → PhonePe*

Once activated, PhonePe appears on **Setup → Payment Gateways** under **Manage Existing Gateways**, where you configure it.

## 3. Fill in the settings

**Setup → Payment Gateways → PhonePe** → enter **Client ID**, **Client Secret**, and **License Key** → choose **Payment Mode** (Redirect or Iframe) → leave **Sandbox Mode** on for now → **Save Changes**. Every field is explained in [Configuration](/phonepe-whmcs/configuration).

![PhonePe gateway configuration fields](/phonepe-whmcs/img/phonepe-installation-settings.png)
*Setup → Payment Gateways → PhonePe*

## 4. Register the webhook in the PhonePe dashboard

In the PhonePe merchant dashboard's webhook settings, set the **Webhook URL** to:

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

Replace `yourdomain.com` with your WHMCS domain. Define a **username** and **password** in PhonePe, then enter the identical credentials into WHMCS **Webhook Username** and **Webhook Password**.

::: warning HTTPS is required
The webhook URL must be reachable over a valid SSL certificate. Without HTTPS, PhonePe can't deliver payment results and invoices won't be marked paid automatically.
:::

## 5. Test in sandbox

Verify checkout flow with **Sandbox Mode** enabled:

1. Click **Pay Now** on a test invoice and complete sandbox checkout.
2. Confirm the invoice automatically marks **Paid** and logs the fee.
3. Check **Utilities → Logs → Gateway Log** to review the webhook and API transaction entries.

## 6. Go live

**Setup → Payment Gateways → PhonePe** → set **Sandbox Mode** to *No* → **Save Changes**. See [Going live](/phonepe-whmcs/guides/going-live) for the full checklist.

## Verify

Confirm the sandbox test invoice is marked **Paid** in WHMCS, then repeat with one small real payment after switching Sandbox Mode off.

## Related pages

* [Requirements](/phonepe-whmcs/requirements) — check your server and PhonePe account
* [Configuration](/phonepe-whmcs/configuration) — the gateway fields explained
* [PhonePe setup](/phonepe-whmcs/guides/phonepe-setup) — credentials and webhook
* [Payment modes](/phonepe-whmcs/features/payment-modes) — redirect vs iframe
* [Settings reference](/phonepe-whmcs/settings) — every field at a glance