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 OpenCart version 2.0 - 3.0
- 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):
- php_openssl
- php_soap
- bcmath
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 PRV 101, the location of the log file UniModul.log was changed to the directory UniModul/logsInstallation
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
Copying of the module files is necessary only for OpenCart version 2.3 and below. For OpenCart version 3.x, the module is installed directly from the eshop administration, see below. Copy the whole content of the appropriate directory, ftp-OCv2.3 for OpenCart 2.3.x or ftp-OCv2.2 for OpenCart 2.2 and below, from the module package to the root directory of your eshop. This copying places the module files into appropriate directories of your eshop. Copy the .key file of your generated private key into the directory UniModul/certs.Installation in the eshop administration
For OpenCart version 3.x only: In the OpenCart administration menu Extensions -> Installer, click Upload and select the file gpwebpaygpe.ocmod.zip from the unpacked installation package.Prior the configuration, it is necessary to copy additional files using ftp.
Copy the .key file of your generated private key into the directory UniModul/certs. In the administration menu of OpenCart Extensions -> Payments the module GP webpay is displayed, click on the respective link [Install] and then [Edit]. Set in the editation:
- 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 of the .key 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.
- Provider ID - Your provider code, displayed in the GPWebPay administration on the e-shop detail page.
- Cron password - enter any password, see section Cron script setting
- Currencies supported - 3-letter ISO currency codes which the gateway supports, they are separated by the space, e.g. "CZK" nebo "CZK EUR", etc.
- Allowed currencies for bank transfer - 3-letter ISO currency codes which the gateway supports, they are separated by the space, e.g. "CZK" nebo "CZK EUR", etc.
- Disallow method change on gateway - For example, it does not allow a change to a payment transfer if the selected payment is by card, 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
- Order status after successful payment
The setting must be saved with the button Save. Prior the configuration, it is necessary to copy additional files using ftp.
Copy the .key file of your generated private key into the directory UniModul/certs. 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
Cron script setting
For checking open transaction status on the payment gateway, it is necessary to set the Cron script on your hosting in order to call the following URL in regular intervals at least once a day:http[s]://www.example.com/index.php?route=extension/payment/gpwebpaygpebinder/callbackcb&_callbackName=checkOrderStatuses&cronSecret=CronPasswordwhere instead of http[s]://www.example.com enter the protocol (http nebo https) and domain of your e-shop and instead of CronPassword enter the cron password you set in the module configuration . If you are using OpenCart version 2.2.x and below, remove the "extension/" part from the url, so instead of "route=extension/payment/" there will only be "route=payment/". This script serves only for exceptional cases, when the client doesn't return from the gateway to the eshop and thus the eshop won't get the payment result. E.g. in case of network problems.
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.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 default file permissions does not allow to create files or write into, it is necessary to create the log file 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 UniModul/sync.lock.
Technical problems with payment
Technical problems during payment can arise due to a problem with the GPWebPay private key, when the payment attempt fails immediately without redirecting to the gateway. This is recorded with a message in the UniModul.log- GPWebPay creating payment exception Cannot open private key file .... in case the module cannot find the required private key. In the e-shop, this is reflected by the warning "Technical error [Cannot open private key file]". (The display of this message in the e-shop may be blocked by the used template, but you will always find it in the log.)
- GPWebPay creating payment exception Bad password or private key in file .... in case the module cannot find the required private key. In the e-shop, this will be reflected by the warning "Technical error [Bad private key password]"
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=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.
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:-
Invalid activation key.
Information about this problem is recorded in UniModul.log.
Make sure that your domain used for generating the activation key is the same as it is in UniModul.log. If this licence is correct, then switch on the detailed error record (log)into UniModul.log,it is described above. -
The usage of the third party extensions which limits the payment possibilities in reliance on the chosen transport e.g.
ship2pay.
To detect this, we recommend that you try another standard payment module and verify that it's displayed. - 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.
Eshop report an error: Notice: ob_clean(): failed to delete buffer.
Activate Output buffering on the server web, module requires it. It is possible to set in php.ini by settingoutput_buffering = On
or add the following line to the eshop .htaccess file
php_flag output_buffering on
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 existIn 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 /system/library/GPWebPayGpe/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
Install the module update in the eshop administration. In the administration, verify the module settings and add any new items. Save the settings even if you haven't changed anything.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 /system/library/GPWebPayGpe/UniModulLang.php and /system/library/GPWebPayGpe/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.Display the graphic logo in front of the name of the payment method
Module enables to display the graphic logo in front of the payment method. It is convenient especially when lots of methods are used. It is an OpenCart extension which is not standard and it is possible to switch it on by adding a line.$GLOBALS['OpenCart_PaymentLogos'] = 1;
in the fileUniModul/UniModulConfig.php. This file is not standardy created and you can copy it from the file UniModulConfig.php.example and then adjust. Logo of the method becomes the a part of the title which becomes longer so we recommend also to wider the size of the field payment_method in the table?_order in the database of the eshop at least up to 400 characters.So the correct displaying of the title of the payment method in the list of the orders will be assured.