joomla virtuemart - omnichannel payment solutions | icepay · 2 icepay implementation manual –...

Joomla VirtueMart Implementation Manual

ICEPAY 9/19/2011

1

ICEPAY Implementation Manual – Joomla VirtueMart

Index UPGRADING ........................................................................................................................ 2

INSTALLATION ..................................................................................................................... 2

CONFIGURATION ................................................................................................................ 7

2

ICEPAY Implementation Manual – Joomla VirtueMart

UPGRADING

If you are upgrading from any ICEPAY module prior to 2.4.0 you are required to deactivate

the old payment method module in VirtueMart > Payment methods.

Please read the installation notes for tips on settings.

INSTALLATION

From 2.4.0+ the ICEPAY module functions as a regular Joomla Component. This means you

must use the Joomla Component installer to use the ICEPAY module. This guide will show

you which steps to take.

In this guide the following combination is used: Joomla 1.5.22 and VirtueMart 1.1.7 in

English.

Download the module from http://www.ICEPAY.com/webshop-modules and save it to your

local machine. You are not required to extract the package.

Log-in to your Joomla Administration section and select Extensions -> Install/Uninstall.

3

ICEPAY Implementation Manual – Joomla VirtueMart

Click on "Browse" (Bladeren) next to "Package files".

4

ICEPAY Implementation Manual – Joomla VirtueMart

Select the downloaded zip file and "Upload/Install" it.

Alternatively you can extract the files, upload them manually to the /tmp folder of Joomla

and install them from there.

Now you'll see the ICEPAY module installation screen. It will detect whether version 2.4.0 is

already installed.

5

ICEPAY Implementation Manual – Joomla VirtueMart

Select "Overwrite config file" to clear previous settings.

Upgrade: During an upgrade it is recommended to keep the previous configuration settings.

Make sure you select the proper vendor and click "INSTALL".

6

ICEPAY Implementation Manual – Joomla VirtueMart

You're all done with installing! Next is configuration.

7

ICEPAY Implementation Manual – Joomla VirtueMart

CONFIGURATION

Go to your Joomla Administrator section and select VirtueMart from the Components menu.

Then go to your payment methods configuration...

8

ICEPAY Implementation Manual – Joomla VirtueMart

Note that the code is ICEBASIC. This is the proper module.

Upgrading: The old module will still be in the list with a different code. Please unpublish or

remove that payment method from the list.

9

ICEPAY Implementation Manual – Joomla VirtueMart

Click on the ICEPAY payment method. You are free to change the Payment method name;

this will define the name of the payment method in the checkout selection screen. Do not

change the code, class or type.

10

ICEPAY Implementation Manual – Joomla VirtueMart

Go to the Configuration tab and ensure the version is correct.

Configure the module settings to your preferred language, currency and country. Note that

not all payment methods are available for all languages, currencies or countries. It is

recommended to use the "detect" settings.

Assign the desired order statuses. The default settings are recommended for optimal

VirtueMart functionality.

It is recommended to activate Log to file. This will help to track payments and problem

solving if needed. The logs will appear in the /logs directory of the root.

The URLs for Success, Error and Notify are automatically generated, you will need to copy

these and paste them into your ICEPAY merchant account. This is vital for ICEPAY to

function. (TIP: Use another browser tab to easily switch between VirtueMart and ICEPAY)

11

ICEPAY Implementation Manual – Joomla VirtueMart

Login to www.ICEPAY.nl and create a new merchant. (Unless you already have one)

Copy the URL for Success, Error and Notify (Postback) into the form. After creating the

merchant you will receive the API key.

If you already have a VirtueMart merchant, ensure the merchant ID and secret code are

correct in VirtueMart and the VirtueMart URLs are correct in ICEPAY.

Copy the Merchant ID and SecretCode from the Merchant API Key into your Module settings.

Save your settings.

You're done!

ICEPAY Wishes You Good Luck with Your e-Business!