---
title: "WHMCS"
slug: "whmcs"
updated: 2023-12-06T15:42:35Z
published: 2023-12-06T15:42:35Z
canonical: "docs.apcopay.com/whmcs"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apcopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WHMCS

Apcopay's plugin integrates with WHMCS, enabling effortless card payment processing, streamlining payment procedures for web hosting businesses.

This article will guide you on how to configure the WHMCS Apcopay plugin. **Kindly download WHMCS module from [here](https://apsp.biz/BO/PluginDownloads/WHMCS.rar){target="_blank"}.**

It is possible to support both **deposits** and **refunds** using our plugin. 

:::(Info) (Information)
Before attempting to integrate with WHMCS, ensure that you are onboarded with Apcopay. Contact [our support team](/v1/docs/contacting-apcopay) to assist you in this regard.
:::

You will need access to the WHMCS portal as well as merchant credentials as provided by our support team. 

### One-time Setup ### 


| Step  | Description |
| --- | --- |
| **Step 1.** Installing the module | To install the new module, upload the provided files in the general information page to **/modules/gateways** folder to your WHMCS installation. </br>**Folder** - apcopay - the whole folder</br>**File** - apcopay.php</br></br>The file in the folder call back must be uploaded to **/modules/gateways/callback** folder. Do not put the whole folder just the file called **apocpay.php** </br> </br>Once these are uploaded, navigate to the admin area of your WHMCS and go to "**setup > Payments > Payment Gateways**" to activate and configure your new module. |
| **Step 2.** Configure settings on **WHCMS** | Go to **"All Payment Gateways"** and you should have **"Apcopay"** listed. Click on it and you should be redirected to configure your settings. </br></br> Fill in the below details</br></br>**Show on Order Form** - This should be activated for the invoices to be able to be paid by the module.</br>**Display Name** - To be shown when the user selects to pay.</br>**Merchant ID** - This can be found in the Apcopay welcome email.</br>**Merchant Password** - This can be found in the Apcopay welcome email.</br>**Profile ID** -  This can be found in the Apcopay welcome email.</br>**Secret Key** - This can be found in the Apcopay welcome email.</br>**Test Mode** *  - Select to be able to perform test transactions on Apcopay Gateway.

**Make sure to switch this off when your website is live.*

**An example of a populated form can be seen below:**

![WHMCS form.png](https://cdn.document360.io/358ada76-9dff-4d31-80ba-dad90c84bfa9/Images/Documentation/WHMCS%20form.png){height="" width=""}

### Creating an invoice to be paid via Apcopay ###

**No additional setup or configuration is necessary**. Moving forward, any invoices issued will feature "Apcopay" as a payment option. Users can simply choose "Pay Now," which will redirect them to our hosted payment page.

Once the payment is successfully processed, the invoice status will be updated to "paid." Additionally, in the admin panel, the order's Payment Status will reflect either "complete" for active orders or "No Invoice Due" for pending orders. Please note that pending orders should be manually changed to active in the WHMCS admin panel.

**Test Card Details:**
For test transactions, use card **4444444444444444**

### Processing Refunds ###

Processing a refund is simple. Select the order from the "admin panel". Click on "**cancel and refund**". The response of the refund should appear on screen. The payment status will be updated to "**refunded**".

### Errors ###

In case of any errors, kindly forward gateway logs to [Apcopay Support](/v1/docs/contacting-apcopay) to be able to assist you with your issues.

These can be found from the admin panel. **Billing > Gateway log**