Revision as of 21:03, 21 March 2022

About this Module

Using Bank Transfer as a gateway will give you a text area to enter payment details for the client that will be displayed on the Client Area invoice. This can be used to enter the bank routing code (sometimes called sortcode) and account numbers and any references required to allocate the payment correctly. As a result the 'forward user to payment gateway' order redirect option will redirect the client to the invoice.

When you receive the payment, you would need to add the transaction manually into WHMCS by using the Add Payment section of the invoice.

Adding the Bank Transfer Payment Gateway

To set up the payment gateway in WHMCS:

1. Go to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Products/Services > Payment Gateways.
2. Choose the All Payment Gateways tab.
3. Click Bank Transfer.
4. Check Show on Order Form to display this payment method in the Client Area during checkout.
5. Configure a display name and the bank transfer instructions.
6. Click Save Changes.

Test Mode

This payment gateway module does not include test mode.

Module Duplication

This module and the Mail In Payment module, are open-source meaning it can be easily duplicated if you wish to offer multiple options.

To duplicate a module:

1. Create a copy of /modules/gateways/banktransfer.php. The new filename must be all lowercase, alphanumeric characters only and contain no spaces.
2. Open the new file in a text editor such as Notepad and change the following three lines to the name of your new module:

    function banktransfer_config() {
    "Value" => "Bank Transfer"
    function banktransfer_link($params) {

   For example:

   <?php
   
   # Bank Transfer Payment Gateway Module
   
   function banktransfercopy_config() {
   
       $configarray = array(
        "FriendlyName" => array(
           "Type" => "System",
           "Value" => "Bank Transfer Copy"
           ),
        "instructions" => array(
           "FriendlyName" => "Bank Transfer Instructions",
           "Type" => "textarea",
           "Rows" => "5",
           "Value" => "Bank Name:\nPayee Name:\nSort Code:\nAccount Number:",
           "Description" => "The instructions you want displaying to customers who choose this payment method - the invoice number will be shown underneath the text entered above",
           ),
       );
   
   	return $configarray;
   
   }
   
   function banktransfercopy_link($params) {
       global $_LANG;
   
       $code = '<p>'.nl2br($params['instructions']).'<br />'.$_LANG['invoicerefnum'].': '.$params['invoiceid'].'</p>';
   
       return $code;
   
   }
   
   ?>

3. The above code would create a new payment gateway module called Bank Transfer Copy.
4. Save the file as banktrasnfercopy.php (the file name must match the function name ie. banktransfercopy).
5. Upload the file to your /modules/gateways/ directory.

The new module will be available for activation under Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.

Troubleshooting

N/A