WHMCS Plugin

How to install and configure iPaymu Direct Payment for WHMCS.

Introduction

What is WHMCS?

WHMCS (Web Host Manager Complete Solution) is a hosting business automation platform widely used by:

  • Hosting Providers
  • Domain Registrars
  • Web Agencies
  • IT Professionals
  • Developers

Key Features of WHMCS

  • Billing Management
  • Payment Management
  • Order Management
  • Customer Support
  • Reporting
  • Domain Registration
  • Hosting Provisioning
  • Fraud Protection
  • Customer Account Management

Beyond hosting, WHMCS can also be used for other products such as VPS, VPN, Email Hosting, Game Server, Domain Service, and other digital products.


Requirements

Pre-Installation Requirements

Before getting started, make sure:

  • WHMCS is installed
  • You have an iPaymu account
  • You have your API Key and VA Number
  • You have FTP or SSH access to your server

Step 1: Download the Plugin

Download the WHMCS plugin from the iPaymu Plugin page.

Download WHMCS Plugin


Step 2: Manual Installation

File Structure

After extracting the plugin, you will find the following files and folders:

callback/
ipaymu/
ipaymu.php

Installation Steps

  1. Copy the entire contents of the callback/ folder to:
/modules/gateways/callback/
  1. Copy the following files and folders:
ipaymu/
ipaymu.php

to:

/modules/gateways/

Step 3: Activate the Module in WHMCS

  1. Go to SettingsApps & Integrations.

Settings Apps & Integrations

  1. Select BrowsePayments.

Browse Payments

  1. Find iPaymu Direct Payment, then click Activate.

Activate iPaymu Direct Payment

  1. Once activated, the Active status will appear. Click Manage.

Module Active Status


Step 4: Configure iPaymu

  1. Enter the following configuration:
FieldValue
EnvironmentSandbox or Production
VA NumberYour iPaymu account VA Number
API KeyYour iPaymu account API Key
  1. Click Save Changes.

iPaymu Environment Settings

Sandbox Mode

Use Sandbox mode for testing before switching to Production mode.


Step 5: Configure Products

  1. Set up the Product Name, Description, and Product Display.

Product Settings

  1. Create a Product Group, then add a Product.

Product Group and Product

  1. Configure Product Pricing as needed, for example:
    • Monthly
    • Quarterly
    • Semi Annually
    • Annually

Product Pricing


Step 6: Purchase Simulation

  1. The customer selects a product, then clicks Order Now.

Order Now

  1. The customer proceeds to Checkout.

Checkout Page

  1. Under Payment Details, select iPaymu Direct Payment, then click Complete Order.

Payment Method Selection


Step 7: Invoice Payment

  1. The invoice is created and the Pay button appears.

Invoice with Pay Button

  1. The customer is redirected to the iPaymu payment page.

iPaymu Payment Page


Step 8: Payment Status

  1. After successful payment, the invoice shows a success status.

Successful Invoice

  1. The invoice status changes to PAID.

Invoice Status PAID


Error Handling

If the invoice amount does not meet the requirements or there is a configuration error, the system will display an error message.

Error Message Example

Troubleshooting Tips

  • Make sure your API Key and VA Number are correct.
  • Ensure the Environment is set correctly (Sandbox for testing, Production for live).
  • Verify that the callback URL is accessible from the iPaymu server.

Integration Flow

Diagram generated via mermaid

On this page