EasyMIGS LogoVersion: 1.3.0

EasyMIGS Plugin for VirtueMart, is a standard Joomla! plug-in of the VMPayment class (i.e. it's written to work with VirtueMart 3.0.10+ payment model) that connects your shop to a MIGS payment gateway.

This plugin does not work with the SHA256 update required in MIGS from 2016 onwards.

 This plugin is not tested with nor does it support VirtueMart 2 — if you need VirtueMart 2.6 support the previous version is still available.

Based on your Merchant account this plug-in supports Visa and Mastercard payments using the MIGS Payment gateway.

To use this plug-in you will need a Bank account with both a Merchant and MIGS facility attached (e.g CBA call this facility CommWeb, ANZ call it eGATE etc).

EasyMIGS for VM3 is available by support subscription ranging from one month to six months, and the six month subscription includes installation and configuration if being used with Australian Banks.

Freee

  • Features
  • Installation
  • CSS Options
  • Requirements
  • Changelog

This plug-in provides the basic 3-Party Payments MIGS support for Visa and Mastercard payments via the VirtueMart 3 VMPayment class — that is to say this plugin provides a standard Payment Method.

As with all of our subscriptions as long as it is active you can download any updates to the sofware and get support by email or through the dedicated support forum. If you have taken out a subscription that includes installation you will need to make sure everything is in place to allow the installation to proceed and be prepared for the post-installation steps.

Notes

Please note the following about this plug-in:

  • local SSL certificates only are supported.
  • standard payments only are available through the MIGS gateway.
  • MIGS gateway does not support recurring payments.
  • MIGS gateway does not support refunds (you must use your gateway providers 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. MIGS documentation refers to this as "3-Party Payments Integration Model" .

These 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 MIGS accounts work 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 MIGS account with them enabled please contact us to get the plug-in upgraded.

Overview

The EasyMIGS plugin for VirtueMart connects VirtueMart 3 with your MIGS gateway to allow you to accept Visa and Mastercard payments directly into your bank account (MIGS based payment gateways in Australia include ANZ eGate, Bendigo Bank and CommWeb/CBA).

Installation

Prior to installing this plug-in you should have already installed VirtueMart 3.0.10+ (documentation 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.

The process for setting up EasyMIGS for VirtueMart follows these broad steps:

  1. Install the plugin on your VirtueMart 3 enabled Joomla website.
  2. Create an Operator in your MIGS account for the plugin to use.
  3. Create the Payment Method of type "EasyMIGS" with the setting of the Operator created in #2
  4. Run a series of test transactions to satisfy your MIGS provider.
  5. Submit results to your MIGS provider and have your MIGS account activated
  6. In your live MIGS account create an Operator for EasyMIGS
  7. Update the Payment Method in VirtueMart 3 with your live Operator settings.
  8. Set Test Mode to No

Steps #1 -> #4 are done for you if you take out a subscription option that includes installation. Post-Paid Setup Steps (#5 -> #8) are covered here and are relatively simple to do.

After VM3 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

Joomla 2.5 Installer

Note - Joomla 2.5 above, Joomla 3.4 below.

Joomla 3.x Installer

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 may need to click on the "Manage" tab to see the installation results):

EasyMIGS 1.3.0 Installed Joomla 2.5

 

 

Now the plugin is ready to be enabled, click on the "enable the plugin" link in the installation message. This will take you to the Plugin Manger and filter for EasyMIGS. Alternatively you can choose Extensions > Plug-ins to open the Plugin Manager and edit the EasyMIGS settings (if you can't see it straight away type "EasyMigs" into the filter search box and press RETURN ↵ ).

Enable Plugin

 

The configuration screen, unlike normal Joomla plug-ins does not have any configuration options, and will look similar to the image below.

EasyMIGS Plugin - Configuration Screen

 

Basic Details Configuration

VM3 Menu - Payment MethodsAgain, unlike most Joomla! plug-ins the configuration of a VirtueMart plug-in is done within the VirtueMart extension. For Payment plug-ins navigate to VirtueMart > 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:

  1. After you have navigated to the Payment Method [List] screen (as mentioned above) click the New button to create a new payment method.

    VM3 New Payment Method

  2. The next step is to select and create the payment type
    1. Provide a Payment Name e.g. "Credit Card via CommWeb" or something else that suits your MIGS account.
    2. Add a Description, this will appear on the Checkout page in the Payment Method section.
    3. Select the Payment Method, in this case EasyMIGS as shown above.

      Payment Method Info Tab

    4. Click the "Save" button (not the "Save & Close" button), this must be done before you can access the Configuration tab.

  3. 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.

    1. 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 Method Configuration Tab - Part 1

    2. Payment Gateway URL: The URL of the secure MIGS gateway. e.g. For the Australian gateway it is 'https://migs.mastercard.com.au/vpcpay'

    3. Language Code: The 2 character Language Code determines the language the MIGS interface is presented in. eg. for Australia it should be 'EN' 

    4. Merchant Identity: Usually this is an uppercase string of letters and numbers reflecting your account name eg. MERCHANCOM01

    5. Merchant Access Code: The MIGS Virtual Payment Client 'Access Code' from the MIGS Admin - Configuration Details screen. eg A12B3C45

    6. Secure Hash: The MIGS Virtual Payment Client 'Secure Hash Secret' from the 'Admin - Configuration Details' screen.

    7. Use Customer Email for vpc_OrderInfo: Setting this option to Yes is not recommended for most Australian banks. Setting it to Yes will use the Customers email address in place of the normal hash value. It is important to note that the 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:

      Order Details - Payment method details

    8. Email Vendor: Send email to the Vendor on confirmation of payment.
    9. 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 Australian banks that required testing prior to going Live with the service.

When you are satisfied that the plug-in is working correctly and your banks 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.

Last Step

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.

The default layout for the Payment Method is VirtueMart usually needs to be adjusted to suit your websites template. To make that easier the EasyMIGS Plugin provides a range of CSS classes for each element of the Payment Method block that it generates and for the Payment Response (i.e. the Success/Failure messages after a payment has been attempted).

The examples below will help you get started in formatting the EasyMIGS payment method to match your template.

Payment Response

Payment Response is the block of HTML displayed after the MIGS transaction has returned from the MasterCard Gateway.

General

You can set some default values for the <table> tag the response is contained in, e.g.:

.vmEasyMIGS_response tr,  .vmEasyMIGS_response td {
    border: none;
}

You can also set some general values for the title of the repsonse block.

.vmEasyMIGS_response_title {   
    font-weight: 700;
    font-size: 1.2em;
    padding-bottom: 0.5em;
    padding-top: 0.5em;
    display: block
}

Success

.success .vmEasyMIGS_response_title {
    color: green;
}

Failure

.fail .vmEasyMIGS_response_title {
    color: red;
}

If a payment does fail and the Cart is set to be retained then you can also use the CSS class vmEasyMIGSCartRetained to style the additional cart retained message.

.vmEasyMIGSCartRetained {
    margin-top: 10px;
    font-style: italic;
    color: grey;
    display: block;
}

Order Information

Labels

.vmEasyMIGSOrderNumber, .vmEasyMIGSAmount, .vmEasyMIGSTransactionDescription {
    font-weight: 700;
}

Other Userful Classes

VirtueMart uses the following classes in the “Cart” page that can be used to style the “Selected Payment” section of the checkout.

.vmCartPaymentLogo{...}
  
.vmpayment_name{...}  

.vmpayment_description{...}

A typical example might be:

./* Push logo to the right of the payment area */
.vmCartPaymentLogo{
    float: right;
    margin-bottom: 1.0em;
}

/* Force name onto it's own line rather than VM default. */
.vmpayment_name{
    display: block;
}

/* Make description larger than VM default. */
.vmpayment_description{
    font-size: 1.0em;
}
  • Joomla 3.4.2+ (or Joomla 2.5.28 — though we recommend the latest version).
  • PHP 5.4+ (we recommend the PHP 5.5 or higher)
  • VirtueMart 3.0.10+

Additional Documentation

As the plug-in works within the VirtueMart 3.x for Joomla! 3.4+ and Joomla 2.5 you will need to refer to the following articles:

  1. Installing an extension for Joomla!
  2. You can read about Configuring EasyMIGS plug-in for VirtueMart 3 in the Installation tab.
  3. CSS adjustments and examples are discussed in the CSS Options tab
  4. If you use our installation service you will need to read about the Post Paid Setup Steps

It's strongly recommended that you be familiar with VirtueMart's docuemtation (please note we are not associated with this content/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).

VirtueMart 2.6.x

We strongly recommend upgrading to VirtueMart 3.x (and Joomla 3.4+). These upgrades provide serious security fixes, performance and feature enhancements that your site will benefit from — we've done a lot of them recently and the benefits are worth the effort. (If you want to upgrade but can't find anyone to do it for you contact us.)

If you need to continue using using VirtueMart 2.6 the previous version of our MIGS plugin —CommWeb MIGS plugin for VM2 will work for standard MIGS payment gateways  (e.g. ANZ eGate, Bendigo Bank, CommWeb etc).

Other MIGS Integrations

If you need a MIGS gateway integrated with a custom application built with Laravel (or generic PHP even) contact us for a quote.

 

This article both EasyMIGS for VirtueMart 3 and the originally named CommWeb/MIGS for VM2 which it replaced.

1.3.0 Release Monday, 12 October 2015

  • 1.3.0 Additions
    • VirtueMart 3.0.10+ compatibility
    • Joomla 3.4+ compatibility
  • 1.3.0 Changes
    • Removed VirtueMart 2.x compatibility

1.2.2 Release Friday, 9 October 2015

  • 1.2.2 Changes
    • Renamed plugin and files to make upgrading easier for new users still running VM2.x.

1.2.0 Release Monday, 4 June 2014 2259

  • 1.2.0 Changes
    • URL encode email address so we don't loose specials like @ or _ or other valid symbols.

1.2.0a1 Release Friday, 07 April 2014 0023

  • 1.2.0a1 Additions
    • Add missing 's' — minor typo.
    • Add UI for new preference to use customer email for vpc_orderinfo hash.
  • 1.2.0a1 Changes
    • Remove unreachable code.
    • Remove unused variables.
    • Remove unused database queries for other currency codes.
  • 1.2.0a1 Fixes
    • Fix "Undefined variable" warning when processing a failed transaction.
    • Fix incorrectly escaped single quotes in Error MSGs from original MIGS supplied files.
    • Fix code style issues.
    • Fix undefined variable warning in _getMerchantTxRef() resulting in missing Order ID section of MerchantTxRef.

1.1.4 Release Monday, 15 October 2013 0057

  • 1.1.4 Changes
    • Move language files to the new Joomla standard location.
    • Update version number to 1.1.4
    • Update manifest < install > attribute.
    • Revert removal of depreciated tag in manifest to support the broken language support in VM2 (seriously)

1.1.3 Release Monday, 13 October 2013 1151

  • 1.1.3 Additions
    • Add a preference to not record orders with failed payment attempts.
    • Fix version in description strings.
  • 1.1.3 Fixes
    • Fix order history comment missing sprintf() call

1.1.2 Release Friday, 6 September 2013 0900 (First Public Release)

  • 1.1.2 Additions
    • Add missing JText call to result codes.
    • Add a check for approved payment amount vs. submitted order amount.
    • Add additional secure hash checking.
  • 1.1.2 Changes
    • Change all message strings to use JText calls.
    • Restore & improve MIGS transaction recording.

 

Free

You need to login to access the forums.

Member Login

You need to Login to access your Subscription details or the Forums.