CommWeb Payment Plugin for VirtueMart 2.0.x, is a standard Joomla! plug-in of the VMPayment class (i.e. it's written to work with VirtueMart 2.0.x->2.6.6's payment model).
This plugin is does not support VirtueMart 3.x or Joomla 3.x. Please see the new EasyMIGS for VM which supports VirtueMart 3 on Joomla 3.4+ and Joomla 2.5.28.
Based on your Commonwealth Bank Merchant account this plug-in supports Visa and Mastercard payments using the CommWeb MIG Payment gateway.
To use this plug-in you will need a Commonwealth Bank account with both a Merchant and CommWeb facility attached.
- Configuring CommWeb MIGS for VM2
This plug-in provides the basic MIGS support for Visa and Mastercard payment.
CommWeb MIGS implementation requires you to have an SSL Certificate installed, and therefore this version of the plug-in requires one as well.
Please note the following about this plug-in:
- local SSL certificates only are supported.
- standard payments only are available through the CommWeb MIGS gateway.
- CommWeb MIGS gateway does not support recurring payments.
- CommWeb MIGS gateway does not support refunds (you must use their web interface).
- Supports sending the order email as the UID or vpc_OrderInfo attribute.
Please note the following about MIGS:
MIGS is a redirect plug-in, that is to say it redirects to your banks branded version of the MIGS page where your customer enters their credit card details. At no time does the MIGS service allow you to see the customers credit card details.
These CommWeb MIGS gateway features are not currently available but can be added:
- 3D Secure, support can be added
- Risk Management, support can be added
- Amex, JCB or Diners, support can be added
The features which "can be added" are not available yet as we haven't had access to an account with the features enabled to test against, no other reason. Due to a quirk in the way CommWeb works while we have implemented the features internally we haven't been able to put them into the released plug-in as we can't actually test them without a client account that has the features enabled.
If you require any of these additional features and have a CommWeb account with them enabled please contact us to get the plug-in upgraded.
- Joomla 2.5.10+ (we recommend the latest version 2.5.20 or later).
- PHP 5.3.10+ (we recommend the latest version of PHP 5.3)
- VirtueMart 2.0.22+ (we recommend 2.6.6).
As the plug-in works within the VirtueMart 2.0.x -> 2.6.6 for Joomla! 2.5 you will need to refer to the following articles:
- Installing an extension for Joomla!
- Configuring CommWeb MIGS gateway plug-in for VirtueMart 2.0
When using VirtueMart 2.0 it is "recommended" that you have the "Official" manual on hand — VirtueMart 2 User Manual eBook (please note we are not associated with this eBook/it's author/VirtueMart.net and provide this link only as a reference for VirtueMart users, it is not an endorsement in any form by us).
Due to changes in VirtueMart 3.x you will need the updated version of this plugin — EasyMIGS for VM which supports VirtueMart 3 on Joomla 3.4+ and Joomla 2.5.28.
The CommWeb MIGS plugin for VirtueMart 2.0 connects VirtueMart with your CommWeb enabled bank account to allow you to accept Visa and Mastercard payments directly into your Commonwealth Bank account (or in theory any other MIGS based payment gateway in Australia).
Prior to installing this plug-in you should have already installed VirtueMart 2.0.x (installation instructions can be found here). N.B. VirtueMart's Installation instruction have moved several times since this article was first written and may do so again, if the link is broken please let us know and we'll update it.
After VM2.0 Installation
To install the plug-in download the current version and install it as you would any normal extension for Joomla!
Choose the file in the Extension Manager: Install screen
Once the installation is complete you will see a post-installation screen similar to this, you may notice differences in version numbers as we do update the plug-ins based on client needs. (N.B. if you have AkeebaBackup Pro installed you will need to click on the "Manage" tab to see the installation results):
Now the plugin is ready to be enabled, choose Extensions -> Plug-in Manager (if you can't see it straight away click on the "Select Type" filter menu and choose the "vmpayment" type, if it's still not visible try typing "migs" into the Filter field).
The configuration screen, unlike normal Joomla plug-ins does not have any configuration options, and will look similar to the image below, the only option that you will really need to check is the "Status" option, it must be set to "Enabled" for the plug-in to be visible within VirtueMart 2.0.
Basic Details Configuration
Unlike most Joomla! plug-ins the configuration of a VirtueMart plug-in is done within the VirtueMart extension. For Payment plug-ins navigate to "Components->VirtueMart->Shop->Payment Methods", from here you can create, edit and publish payment methods.
Setting up a VirtueMart Payment Method
VirtueMart provides basic documentation on creating a Payment Method on this page.
You may also want to read this page on setting "Logo for Payment and Shipment" on the VirtueMart website.
The basic steps on creating a payment method are:
- After you have navigated to the "Payment Method [List]" screen (as mentioned above) click the "New" button to create a new payment method.
- The next step is to select and create the payment type
- Provide a "Payment Name" e.g. "Visa/Mastercard via CommWeb" or something else that suits your needs.
- Select the "Payment Method", in this case "VM Payment plugin for MIGS" as shown below.
- Click the "Save" button (not the "Save & Close" button), this must be done before you can access the Configuration tab.
The Configuration tab becomes available after you click the "Save" button and this is where you'll provide all of your Merchant details that VirtueMart will need to access your CommWeb MIGS facility.
The MIGS settings are provided by your bank, usually when your facility is approved. In most cases you can also get them from your MIGS/CommWeb facilities web interface.
N.B. It is normal practice that your MIGS credentials provided for the initial setup and testing are replaced with new ones once your account is approved for live transactions.
Payment Gateway URL: The URL of the secure MIGS gateway. e.g. For the Australian CommWeb gateway it is 'https://migs.mastercard.com.au/vpcpay'
Language Code: The 2 character Language Code determines the language the MIGS interface is presented in. eg. for Australia it should be 'EN'
Merchant Identity: Usually this is an uppercase string of letter reflecting your bank account name eg. MYSHOPM01
Merchant Access Code: The MIGS Virtual Payment Client 'Access Code' from the MIGS Admin - Configuration Details screen. eg A12B3C45
Secure Hash: The MIGS Virtual Payment Client 'Secure Hash Secret' from the 'Admin - Configuration Details' screen.
Use Customer Email for vpc_OrderInfo: Setting this option to 'Yes' is not recommended for CommWeb. Setting it to 'Yes' will use the Customers email address in place of the normal hash value. It is important to note that eh MIGS API specifies that vpc_OrderInfo only allows for 40 characters, testing also indicates that it only accepts letters and numbers from the ASCII range, removing any characters that don't meet these limitations. We strongly recommend that you do not turn this option on unless requested by your bank.
If you use this option the change will be reflected in the "Payment Method Details" panel of each Virtuemart Order processed by the CommWeb MIGS for VM2 plugin. The difference is highlighted in the image below:
Email Vendor: Send email to the Vendor on confirmation of payment.
Email Customer: Send email to the Customer on confirmation of payment.
Test Mode Settings
When you first install the CommWeb MIGS plugin it will default to Test mode being enabled (i.e. it is set to Yes), we default to Test mode based on our experience with CommWeb's Support Centre that required testing prior to going Live with the service.
When you are satisfied that the plug-in is working correctly and CommWeb have enabled your Live account you can set this option to No.
Don't forget to update your Merchant ID and Password to the Live versions as well.
"Restrictions" and "Return to Shop"
These two sections are VirtueMart settings and common to all Payment methods, you can read about them on the VirtueMart webiste.
Once you have configured your plug-in simply click the "Save & Close" button to save your configuration and you're done. Now you can finish setting up your VirtueMart installation and start testing your payment plug-in.