Payment Module GP webpay for VirtueMart 2 and 3
Installation Instructions

#Ver:PRV098-49-ga9cb64a5:2022-11-14#

Terms of Use


The extensions offered are provided free of charge by Global Payments Europe, s.r.o. (“GPE”) and are explicitly not part of the GPE range of products and services.

They have been tested and approved for full functionality in the standard configuration (status on delivery, “as is”) of the corresponding shop system.

Limitation of liability:
UNDER NO CIRCUMSTANCE WILL GPE HAVE ANY LIABILITY FOR ANY CLAIMS FOR INDIRECT, CONSEQUENTIAL, INCIDENTAL, SPECIAL, EXEMPLARY, OR PUNITIVE DAMAGES OF ANY NATURE WHATSOEVER, INCLUDING BUT NOT LIMITED TO: LOSS OF PROFITS, GOODWILL, USE, DATA, FUTURE BUSINESS, OR PRODUCTION; CLAIMS OF THIRD PARTIES; CANCELLATION OF CONTRACTS ENTERED INTO BY YOU; OR OTHER INTANGIBLE LOSSES.

GPE cannot and does not provide any guarantee or warranty that will ensure that your's software, systems or products will not be vulnerable, susceptible to exploitation, free from hacking, and/or eventually breached.

You, and not GPE, is solely responsible for the security of its software, systems and products and of any responsibility for the design, manufacture, testing, marketing, sale, and security of your's software, systems and products.

GPE does not provide any guarantee or accept any liability for any errors occurring when used in an enhanced, customized shop system configuration.

Operation in an enhanced, customized configuration is at your own risk and requires a comprehensive test phase by the user of the extension.

Customers use the extensions at their own risk. GPE does not guarantee their full functionality neither does GPE assume liability for any disadvantages related to the use of the extensions. Additionally, GPE does not guarantee the full functionality for customized shop systems or installed extensions of other vendors of extensions within the same shop system.

Customers are responsible for testing the extension’s functionality before starting productive operation.

By installing the extension into the shop system the customer agrees to these terms of use. Please do not use the extension if you do not agree to these terms of use!

Uninstalling the extension may result in the loss of data.

Legal Notes
No warranty whatsoever can be granted on any alterations and/or new implementations as well as resulting diverging usage not supported or described within this documentation.

Installation Prerequisites


Problem solution and support

This manual includes not only the installation description but also the solution of typical problems with the payment gateway. If you have a problem during the installation, firstly read carefully this manual. If you are not able to solve the problem even after reading the manual, write the detailed description of a problem and description of your steps to solve the problem. We may ask for a log. We usually do not need the access data to your e-shop.

You can also order the module installation and setup service from our external supplier:
Order the module installation and setup service

Important change when updating

When updating the module from the original version older than PRV088-35 , the location of the UniModul directory was changed from the root directory of the eshop to the directory plugins/uniadapter/vmadapter/lib/UniModul
Please follow the instructions in the Module Update section Please follow the instructions at the section this link to update.

Installation


Digital key generation and payment gateway setting

The GP WebPay gateway provides testing and production modes. These modes are fully independent and have its own key.

For GP WebPay (testing or production mode) you need to generate the digital key in the test web administration on https://test.portal.gpwebpay.com or in production web administration at https://portal.gpwebpay.com in the section Key management. The generated .key file has to be assigned to the respective account on the same site. You'll use the generated key also in the installed module setup, see below.

On the GP WebPay portal in the eshop settings ensure the option "HTTP method for response" is set to "GET".

Installation in the eshop administration

Install the payment plugins

Prior the configuration, it is necessary to copy additional files using ftp.
Copy the .key file of your generated private key into the directory plugins/uniadapter/vmadapter/lib/UniModul/certs.

In the VirtueMart administration choose the list of Payments Methods in the v menu Control Panel. In the top menu choose icon New. And fill in these fields: Choose Save in the top menu. And then choose the tab Configuration. During the first launching the configuration of the module may report some mistakes but they disappear after first saving of the configuration.

Then fill in the following fields: Save the settings using the 'Save' button.

Warning: Do not use the default order status "P" (Pending) for paid orders. This status is set by VirtueMart automatically for every new order until it is changed by a plugin or administrator.

Note: To display the graphic logo next to the payment methods copy all .png pictures from the directory plugins/uniadapter/vmadapter/lib/UniModul into the directory /images/virtuemart/payment in the eshop. Then these pictures can be chosen in the payment method settings.

Now verify the module functionality by doing a payment as a customer. In the testing mode of GPWebPay it is necessary to use the testing card received with the documentation from the gateway.

Creating the activation key

Switching to the production mode

After successful testing payment in the testing mode you can switch to the production mode where you can pay with the real credit cards.

Write a request to gpwebpay@gpe.cz and ask them to enable the production mode which is initially blocked. Generate the key the same way you did in the test or you can insert the key from the test into the production. When the production mode is launched you have to adjust the setting of the module in eshop administration. You have to switch to the production gateway according to the instructions here above.

Particular payment methods

The payment module described above enables the payment with all methods provided by the system GPWebPay. The customer chooses the payment method when he is paying GPWebPay, he is redirected to payment gateway where he chooses one from lots of offered methods e.g. paying with the credit card or money transfer and so on.

It is also possible to activate these particular payment methods as separate payment options.

The particular payment options have form of additional payments modules. These modules have no specific settings and use the setting of the base module GP webpay. This modul has to be always enabled If you do not want show it to the customers see it, in the administration set the item "Hide the main module and use only particular methods" to "yes". The particular modules has to be installed same as the base module as described above. They have to be copied to the tmp directory and installed and enable through the extension manager and finally add it as a payment module in VirtueMart.

Problems solution


Find out the cause of an unsuccessful payment in log file

Technical information about the communication with the payment gateway are logged in the file plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log. In case of the problems with the payment you can find the cause of the failure in this log.

Setting of the files permissions

Module requires permissions for reading and writing into the several files. If the default file permissions does not allow to create files or write into, it is necessary to create the log file plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log manually and set the permissions for writing from the web server.If you use Total Commander, you write in the command line: chmod 666 UniModul.log, by this action you make your file maximally accessible. But the files should not be visible for the others webs on the relevant web hosting, for this reason you have to have information about the permissions setting from your web hosting before launching production operation.
It is also necessary to set the write permissions to the file plugins/uniadapter/vmadapter/lib/UniModul/sync.lock.

Technical problems on the gateway GPWebPay or after returning to the eshop

The gateway GPWebPay can refuse the payment either because of the business reason e.g. the customer's credit card was not verified or because of technical reason e.g. the configuration problem of the gateway or of the module.

While finding out the problem with the payment, firstly look at the administration GUI GPWebPay.Check the status of the payments. If they are registered there as unpaid then there is not a problem in your eshop and you have to contact GPWebPay. If there is a payment registered as paid and the module labeled it as refused or the payment is not registered there at all, proceed accordingly to the paragraph bellow.

Detection of the problem using the log file of the payment module

Technical problem occurs either directly on the side of the gateway GPWebPay or after returning back to the eshop. The module informs the customer about the unsuccessful payment and states that there is a technical problem. In the log plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log you can find it at the end of the file in the line in the form :
*** Sun, 01 Feb 2014 18:48:28 +0100 REPLY Signature result=1 OK 99.99.220.216 /modules/PrestaAdapter/validation.php?uniModul=GPWebPay&unimodul=GPWebPay&OPERATION=CREATE_ORDER&ORDERNUMBER=1152&MERORDERNUM=2015090064&MD=X&PRCODE=0&SRCODE=0&RESULTTEXT=OK&DIGEST=....
Code for the errors of payment gateway is stated as PRCODE, SRCODE, and text interpretation RESULTTEXT. Typical technical errors which are connected to the module settings are: In the case of the other error codes, contact the GPWebPay support. It is recommended to send a request to the gateway which includes the text MAKING_ORDER_URL, send them also a part of the log with the line where the error code occurs and the line in front of it.

Detailed error record in the log file

If the module does not work properly and standard log events into plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log do not help to find the cause, you can switch on broaden log of the errors into the log file mentioned above. There you can find the cause of the problem or you can send us this log for further analyses of the problem.

Error record in the log file can be switched on by adding the line
$GLOBALS['UniErrorControl'] = 1;
in the file plugins/uniadapter/vmadapter/lib/UniModul/UniModulConfig.php. This file is not standardly created and it has to be copied from the file UniModulConfig.php.example and then you can adjust it. For the regular usage we recommend to switch off the error recording (log).Communication record ( log)with the paying gateway is always switched on and cannot be switched off.

Module is not displayed in the choice of the payments

Module is set in the administration but while ordering, the module is not displayed.

Possible causes:

The unimodul_transactions database table is missing

The following error appears in the log when error logging is enabled: Query Failed! SQL: insert into unimodul_transactions, Error: Table '.unimodul_transactions' doesn't exist
In this case, the module could not automatically create this table during installation and must be created manually:

Log in the eshop database administration on your web hosting and create database tables by running the script plugins/uniadapter/vmadapter/lib/UniModul/UniModul.sql. (It is sufficient to copy-paste the content of the file to the field of the SQL Command in the PhpMyAdmin)

FAQ


Module update

When updating the module from the original version older than PRV088-35 , the location of the UniModul directory was changed from the root directory of the eshop to the directory plugins/uniadapter/vmadapter/lib/UniModul

After installing an upgrade from a version earlier than PRV088-35 , perform the following steps: General rules for updating:

If you update the module you have to save all files which you have changed manually. These are usually configuration and edited language files. Then you have to copy the files of the new version and change the files of old version. After that you copy your changes in the saved files into the new files of the module.

Then you check that the database scripts respond to the created charts. Eventual changes in the database have to be done manually.

In the end check the setting of the module in the administration and add eventual new items. In some cases the administration reports some errors during the first activation but this errors disappear after the first saving of the new configuration. If the problems remain, uninstall the module from the administration and then again re-install and set.

Pairing of payments

Module automatically pairs the payments with the orders in the e-shop and sets the order status.

For some cases e.g. manual payment reversal in the administration of payment gateway it is necessary to find the transaction related to the relevant order in the payment gateway. In the eshop administration there is the transaction number of the payment gateway displayed in the order detail comment.

Sometimes it is necessary to find the relevant order in the e-shop to the relevant transaction in the payment gateway. The number of the order from the eshop is transmitted to the payment gateway in the field Merchant order number or in the description of the transaction if it includes the letters. It is displayed in the transaction detail in the administration of GPWebPay account and also on the account statement from the bank.

Localization and text editing

Texts and translations are partly solved standardly as it is for the standard module but there are some specific things and the text and translations are saved in the field plugins/uniadapter/vmadapter/lib/UniModul/UniModulLang.php and plugins/uniadapter/vmadapter/lib/UniModul/UniGPWebPayLang.php.You can change the text or add a new language by editing this field.

If you add a new language in the localization file please send us the edited files. We will add it to the next versions so it will be helpful for other customers but also for you in the future while updating.

Module removal

Firstly remove the module from the administration of eshop. Then delete all copied files which you have copied from the installation directory ftp during the installation.