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
- Eshop based on PrestaShop version 1.4.x - 1.7.x
- The agreement with the payment gateway GP webpay
-
Access to eshop FTP and access to the eshop administration
-
Enabled following PHP extension on your hosting (available on majority of the hostings by default):
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 serviceInstallation
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".
Copying of the module files
Copy the whole content of the directory
ftp from the module package to the root directory of your eshop. This copying places the module files into appropriate directories
of your eshop.
If you install more than one module, you need to copy again all common directories e.g. UniModul. They include not only
common files but also the specific files for the fixed sort of payment.
Copy the .key file of your generated private key into the directory UniModul/certs.
Installation in administration of the eshop
In the PrestaShop administration choose the menu Improve -> Modules -> Module Catalog. Find the module by the word "GPE"
and click the Install button and then the Configure button. For later module setting you'll find the module in the menu Improve
-> Modules -> Module Manager.
In the older PrestaShop versions you find the module in menu Modules and Services -> Modules and Services.
In the module settings fill in these fields:
- Activation key - Insert the activation key created in the section Creating the activation key below.
- Test gateway - Yes - test environment, No - production environment. Use the test environment first.
- Merchant Number - Your merchant number at GPE.
- Merchant private key file - into the private key file write the name .key of the file of your private key file copied into
the directory UniModul/certs
- Merchant Private key password - the kay password entered during the generation of your key.
- Deposit flag - determine if the money should be transfer from the card immediately or it is only the pre-authorization, we
recommend to set the immediate transfer.
- Currencies supported - 3-letter ISO currency codes which the gateway supports, they are separated by the space, e.g. "CZK"
nebo "CZK EUR", etc.
- Gateway order number offset - the offset of the order number in the payment gateway, we recommend to set during the installation
to 1000 and then do not change. In case of reinstallation into the empty database of the eshop, it is necessary to set the
value of this number higher than the last existing order number of the payment gateway
- Permitted payment methods
- tick the payments methods provided by the gateway you want to be displayed. The first ticking box displays the general
method and the customer chooses the concrete method on the side of the gateway. It is recommend not to the general gateway
and tick the concrete methods. The usage of the methods depends on their authorization by the gateway. See the paragraph Individual
payment submethods as the independent payment modules.
- Order status after successful payment
- Order status while waiting for the money transfer
- Order status when the payment fails
- Create the order before the payment - the order number is known before the payment and will be transfered to the payment gateway
for easier pairing. Then, even every unsuccessful payment attempt will be registered as an order with an unsuccessful payment.(
This is an experimental functionality, which does not change the behavior of ordering process). PrestaShop usually creates
the order only in the case of successful or waiting payment so it is not possible to transfer the order number to the gateway.
- Display the confirmation side - determines,if after clicking on the button of the payment method the side with the recapitulation
and the order confirmation will be displayedin the order process before the transfer itself to the payment gateway. this side
might display some additional information e.g. currency conversion. the choice "Only during the info" displays the confirmation
side only in case of the additional information content.
Save the setting with the button Update Settings.
Then click again on Payment and in the table currency constraints choose all currencies, for which you want to enable
the payment with this module. Save the setting with the button Save limitation.
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 payingGPWebPay, 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 a separate payment options.
The offer of the particular methods is to set in the configuration of the module using checkboxes.
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
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 standard setting of file permissions
does not allow to write into these files not even to create it in case of log, it is necessary to create the log file
UniModul/logs/UniModul.log manually (e.g. rename the file
UniModul.log.empty) 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
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 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=....
-
If there is stated in the log in this line Signature result= INVALID instead of OK, the problem is in the configuration of the public key GPE in the modul administration, typically the testing and production
key were mistaken.
If the public key is correctly set, so te problem is sometimes caused by url-decoded answering URL. It can be recognised
because the symbol "+" occurs somewhere in the chain in the log in the parameter DIGEST or DIGEST1. This symbol "+" does never
occur in the original answer from GPWebPay. This error is caused by the different SEO plugins which make an incorrect transfer.
The solution is either repair the plugin which causes this incorrect transfer or switch it off.
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:
-
PRCODE=31 - Incorrect signature. You do not have registered correct public key .cer for your private key .pem. Contact
the GPWebPay support.
-
PRCODE=2, SRCODE=34 - Private merchant key is incorrectly set or there is an incorrect password for it in the module
administration.
-
PRCODE=3, SRCODE=7 - Unsupported currency.Contact your bank or the GPWebPay support.
-
PRCODE=14 - The order number is duplicated. Solution:In the setting of the module you have to set the number of the first
order higher than it is the last number of the oder GPWebPay which can be found in their administration GUI.
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 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
/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:
-
Module is not displayed because of the disagreement of the currency set in administration of the module and the currency
of the basket or the the amount out of allowed limits for the payment method.
-
Other error in module processing.
Switch on the detailed log of errors into the UniModul.log. It is described above.
-
Disabled non PrestaShop original modules. In the PrestaShop administration in the section Advanced parameters - Performance
- Debug mode turn off both option Disable non PrestaShop modules and Disable all overrides
Administration of the module in PrestaShop 1.6.0.12-13 does not work
PrestaShop versions 1.6.0.12-13 version refuses all titles with capital letters. This error is solved in the version
1.6.0.14. Update to the newer PrestaShop version.
Amount is not round off in the payment gateway
Some e-shops the setting of currency rounding off in the way that the round off amount is only displayed but internally
e-shop keeps a record of an amount not rounded off. Payment module works with an amount saved in the e-shop and in the gateway
the customer pays the unrounded amount.
It is possible to force the amount rounding off which is send to the gateway by setting up the file
/UniModul/UniModulConfig.php,where you insert:
<?php
$GLOBALS['UniPrestaShop_RoundPrice'] = true;
Beware the amount stored in PrestaShop is still unrounded.
Using the order id instead of the reference
If there is chosen "Create the order before payment" in the administration of the module, the module sends the order
reference to the payment gateway.
Unfortunately the reference may contain letters which cannot be passed to the payment gateway.
We recommend to use some third party module to adjust order reference format c.f.
PrestaShop Custom Number Pro – Order and Invoice Number.
Nevertheless, our module allows setting to use numerical order id instead of the reference.
It can be configured by creating the file
/UniModul/UniModulConfig.php by inserting:
<?php
$GLOBALS['UniPrestaShop_UseOrderId'] = true;
FAQ
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 section Information of the payment gateway in order detail in the eshop administration.
Sometimes it is necessary to find the relevant order in the e-shop to the relevant transaction in the payment gateway.
If there is chosen " Create the order before being payed" in the administration of the module, module transmits the
number of the order to 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.
Why is the module PrestaAdapter also installed?
It is the support module of the payment module its own.Do not install the Module but it must not be totally removed.
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 UniModul/UniModulLang.php and UniModul/UniGPWebPayLang.php.You can change
the text or add a new language by editing this field.
For editing the common texts which are not related to the particular payment method the translations are set standarty
within the module PrestaAdapter.Firstly, this module has to be installed and then work on the translations.
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 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.
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.