Skip to content

AdrienDssy/whmcs-gateway-fees

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gateway Fees Module for WHMCS

Description

The Gateway Fees module for WHMCS allows you to configure and apply additional fees based on the payment gateway used for transactions. You can set fixed fees and percentage fees for different payment gateways and currencies.

Creator

  • Original Author: Adrien Dessey (AdKyNet SAS)
  • Update by: Yann Martin

Installation

  1. Upload the Module:

    • Upload the gateway_fees directory to the /modules/addons/ directory of your WHMCS installation.
  2. Activate the Module:

    • Log in to your WHMCS Admin Area.
    • Navigate to Configuration > System Settings > Addons.
    • Find "Gateway Fees" in the list and click Activate.
  3. Configure the Module:

    • Once activated, click Configure next to the "Gateway Fees" module.
    • Set the desired options:
      • Enable Logs: Enable or disable logging.
      • Delete Table on Deactivation: Choose whether to delete the module's SQL table when deactivating the module.

Configuration

  • Fees Configuration: After activation, you can configure fees for different gateways and currencies:
    • Fixed fee (fee_1_<gateway>_<currency>): Set a fixed amount fee.
    • Percentage fee (fee_2_<gateway>_<currency>): Set a percentage fee based on the invoice total.

Hooks

The module includes hooks to automatically update invoice totals with gateway fees:

  • InvoiceCreated: Applied when an invoice is created.
  • InvoiceChangeGateway: Applied when the gateway of an invoice is changed.
  • AdminInvoicesControlsOutput: Applied to display additional controls in the admin area.

Logging

If logging is enabled, logs will be written to gateway_fees.log in the module directory. This can be useful for debugging and tracking fee calculations.

Deactivation

When deactivating the module, you have the option to delete the module's SQL table. This can be configured in the module settings.

Support

For support, contact:


Note: Always backup your WHMCS installation and database before installing or modifying modules.

About

WHMCS Module for adding gateway fees to your customers (WHMCS 8.X)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages