Skip to main content

Virtuemart Setup Guide

This is a step by step guide to integrating Nochex with your Virtuemart website.

Important

Customers are always recommended to back up their code before making any significant changes, such as the ones detailed in this document.

Virtuemart 4.0.6 Installation Instructions

  1. Firstly you must have Joomla and VirtueMart installed and configured on your website!

  2. Download the latest module files, which can be found here.

    1. Go to the Nochex GitHub, and click on the ‘Source Code (zip)’ link

      Virtuemart Nochex GitHub

    2. This will download a copy of the Nochex module

    3. Go to the downloaded module, and extract the module files;

  3. Copy the extracted module files to the corresponding Joomla folders on your web server. You can use FTP for this process or a File Manager.

    Virtuemart Nochex Module

  4. Login to your Joomla admin area

    Joomla Admin

  5. Go to System > Install > Discover

    Joomla Module installer

  6. This will show your Nochex module

    Virtuemart Nochex Module

    If your Nochex plugin does not show, please check your module files have been uploaded correctly.

  7. Click the checkbox next to VMPAYMENT_NOCHEX or Nochex

    Virtuemart Nochex Ticked

  8. Press the Install button, to install the Nochex Module.

    Install Button

Virtuemart Payment Methods
  1. Once installed, a successful message will be shown.

    Installed Correctly

  2. Next, Go to Components > VirtueMart > Payment Methods

  3. This will show your VirtueMart payment methods

    Virtuemart Payment methods
  4. Press New button to add a new payment method

    New Button

  5. This will load the following;

    Virtuemart Payment Method Options
Virtuemart nochex settings
  1. Enter the following into each of the above fields

    • Payment Name (Required) – Nochex
    • Sef Alias (Required) – nochex
    • Published (Required) – Yes
    • Payment Description (Optional) – Can be left blank
    • Payment Method (Required) – VMPAYMENT_NOCHEX
    • Shopper Group – leave blank
    • List Order (Optional) - 0
    • Currency (Required) – British Pound
  2. Once complete, save all changes

    Save Button

  3. Once saved, click on the grey configuration tab to show your module settings

    Configuration Button

  4. This will show the following;

    New Button

  5. Complete all of the relevant settings;

    • Logos at Checkout – Logos / Images you would like to display on the checkout page (Required)

    • Nochex Email Address / Merchant ID – Your Nochex Merchant ID / Email address, for example: you@yourbusiness.com (Required)

    • Test Mode – To check if everything is working. After you have found that everything is working, remember to put the status to Live Mode, otherwise no money can be accepted.

    • Hide Billing Details – To hide billing details.

    • Show Postage – Show Postage on your Nochex account

    • Detailed Product Information – Display products in a structured and detailed format on your payment page

    • Order Status for Pending transactions – Status for pending transactions (Required)

    • Order Status for Successful transactions – Status for successful transactions (Required)

    • Order Status for failed transactions – Status for failed transactions (Required)

  6. Save all changes

    Save Button

  7. Go through the checkout process to make sure the module has installed and setup correctly.

    Once you have gone through the entire process as a customer you will receive payment notifications, and an updated order will be visible in your VirtueMart along with payment information

    caution

    Remember: Disable Test mode in your Nochex Module once you are ready to accept live transactions

Virtuemart 3.x Installation Instructions

  1. Firstly you must have Joomla and VirtueMart 3 installed on your website.

  2. Download the latest module files, which can be found here.

    1. Go to the Nochex GitHub, and click on the 'Source Code (zip)' link virtuemart github
    2. This will download a copy of the Nochex module
    3. Go to the downloaded module, and extract the module files;
  3. Copy the extracted module files to the corresponding Joomla folders on your web server. You can use FTP for this process or a File Manager.

virtuemart download

  1. Login to your Joomla admin area

virtuemart admin login

  1. Go to Extensions > Management > Discover

virtuemart extensions discover

  1. This will show your Nochex module

virtuemart nochex option

  1. Click the checkbox next to VMPAYMENT_NOCHEX

  2. Press the install button, to install the Nochex Module.

virtuemart install button

  1. Once installed, a successful message will be shown

virtuemart installation confirmation

  1. Next, Go to VirtueMart > Payment Methods

  2. This will show your VirtueMart payment methods

  3. Press New button to add a new payment method

virtuemart new payment option button

  1. This will load the following;

virtuemart nochex settings

  1. Enter the following into each of the above fields

    • Payment Name (Required) - Nochex
    • Sef Alias (Required) - nochex
    • Published (Required) - Yes
    • Payment Description (Optional) - Can be left blank
    • Payment Method (Required) - VMPAYMENT_NOCHEX
    • Shopper Group - leave blank
    • List Order (Optional) - 0
    • Currency (Required) - British Pound
  2. Once complete, save all changes

  3. Once saved, click on the grey configuration tab to show your module settings

virtuemart nochex configuration

  1. This will show the following;

virtuemart nochex configuration options

  1. Complete all of the relevant settings;

    • Logos at Checkout - Logos / Images you would like to display on the checkout page (Required)
    • Nochex Email Address / Merchant ID - Your Nochex Merchant ID / Email address, for example: you@yourbusiness.com (Required)
    • Test Mode - To check if everything is working. After you have found that everything is working, remember to put the status to Live Mode, otherwise no money can be accepted.
    • Hide Billing Details - To hide billing details.
    • Show Postage - Show Postage on your Nochex account
    • Detailed Product Information - Display products in a structured and detailed format on your payment page
    • Order Status for Pending transactions - Status for pending transactions (Required)
    • Order Status for Successful transactions - Status for successful transactions (Required)
    • Order Status for failed transactions - Status for failed transactions (Required)
  2. Save all changes

  3. Go through the checkout process to make sure the module has installed and setup correctly

Once you have gone through the entire process as a customer you will receive payment notifications, and an updated order will be visible in your VirtueMart along with payment information.

Important

Remember: Disable Test mode in your Nochex Module once you are ready to accept live transactions