1Introduction
This manual leads you through the installation, configuration and usage of the payment module for OXID and EMS eCommerce Gateway.
Before you can begin with the installation, please make sure that you are in possession of all the necessary data:
- You should have received a Store ID from EMS eCommerce Gateway(Usually an eleven digit combination of numbers )
- Shared Secret for the usage of Connect (Shared Secret Connect Interface)
- If you are working with the professional version of the module and have requested the API Interface with EMS eCommerce Gateway, you should furthermore have received an API User ID, a client certificate as well as the corresponding passwords
Note that you must use at least PHP version 5.6 for our plugins. PHP 8 or higher is currently not supported.
1.1Process of the Installation
In this document you will find all the information necessary for the installation of the module. It is important that you follow the checklist strictly. Only if you comply with each step we can ensure a secure usage in correspondence with all security regulations.
- Configuration of the basic settings of the payment module
- Configuration of the payment methods
- Carrying out a test purchase by means of the attached test data at the end of this document
Our payment plugins should have per default the correct settings for most of our customers' preferences. That means once you have entered the required credentials in the plugin configuration to connect your account to your website, the plugin should be fully operational. Should you be willing to receive detailed information on a setting you do not know, you may contact our support team who will be able to assist you further.
Our support team is at your disposal during regular business hours at: http://www.sellxed.com/support. Furthermore, you have the option of ordering our installation service. We will make sure the plugin is installed correctly in your shop: http://www.sellxed.com/shop/de/integration-und-installation.html
In order to test the module, any kind of directory protection or IP blocking on your server must be deactivated. This is crucial as otherwise the payment feedback of EMS eCommerce Gateway might not get through to the shop.
1.2System Requirements
In general, the plugin has the same system requirements as OXID. Below you can find the most important requirements of the plugin:- PHP Version: 5.4.x or higher
- OpenSSL: Current version with support for TLS 1.2 or higher.
- fsockopen: The PHP function fsockopen must be enabled. The plugin must be able to connect to external systems over the Internet.
- PHP Functions: All common PHP functions must be enabled.
2Configuration EMS eCommerce Gateway
If you have merely bought the Standard Version of the module you only need to comply with the part Configuration of the Module
2.1Test Environment and Live Platform for Administration
You can find the administration and the transaction overview if you click on this link (A client certificate is needed to access):
Please note that you can only access the testing platform with a corresponding client certificate which you receive fromEMS eCommerce Gateway.
2.2Mandatory: Configuration of the Module
Navigate to the main module in your shop. Please fill in the following data in to the appropriate location:
- Store ID (you will receive this directly from EMS eCommerce Gateway)
- Shared Secret (you will receive this directly from EMS eCommerce Gateway)
The remaining settings in the main module regard specific fraud settings to identify transactions without 3D secure. The default settings are set correctly for most of them.
Please note that momentarily there is a problem at EMS eCommerce Gateway with certain certificate types. In case no order confirmation mails are being sent out and the status of the order is still set to Pending EMS eCommerce Gateway and the status then changes to Cancelled you have to switch to Yes at Force Non SSL Notification.
2.3Optional: Professional Version - Creating a Certificate File
By working with the Professional Version of the module you can operate the transaction management directly from your shop. This way you don't need to install the certificates to access the backend. To be able to use these functions you must already have bought the Professional Version of the Module at www.sellxed.com/shop. Otherwise you will not have access to these features. In order to change to the Professional Version contact us at contact.
You will receive a ZIP from EMS eCommerce Gateway containing a key (file extension .key) as well as the certificate (file extension .pem) in order to use the backend and the transaction management. Extract these files into a directory of your choice and carry out the following steps:
- Open the certificate (file with the extension .pem)
- Open the key simultaneously (file with the extension .key)
- Insert the content of the key underneath the certificate file
- Save the certificate file and copy it into: files_4/lib/Customweb/EMSeCommerce/Certificates/Default/
- You can now proceed to the instructions for the installation.
2.4Activating the Payment Methods and Testing
Further information regarding the configuration of the payment methods and the meaning of the specific settings can be found here. When you have activated and configured the payment methods you can run a test by means of the published Test data in the manual. If all tests were successful, switch the operating mode in the main module to Live.
3Module Installation and Update in the OXID Shop
3.1Installation
At this time you should already be in possession of the module. Should this not be the case, you can download the necessary files in your customer account in the sellxed shop (Menu "My Downloads Downloads"). In order to install the module in your shop, please carry out the following steps:
- Download the plugin. The download can be found in your sellxed.com account under "My Downloads".
- Unzip the archive you have just downloaded.
- In the unzipped folder navigate to the folder "files"
- For some shops there are different versions of the plugin provided. If this is the case open the folder which corresponds to your shop version.
- Using your preferred FTP client upload entire content of this folder into the root directory of your shop. For some shops there is a specific folder containing the plugins. If that is the case upload the plugin into this folder. Make sure that the folders aren't replaced but merely merged.
- If you haven't yet done so, log back into your shop.
3.2Updates and Upgrades
You have direct and unlimited access to updates and upgrades during the duration of your support contract. In order to receive constant information about available updates we ask you to subscribe to our RSS feed that we publish for your module.
More information regarding the subscription of this RSS feed can be found under: http://www.sellxed.com/en/updates_upgrades.
We only recommend an update if something doesn't work in your shop, if you want to use new feature or if there is a necessary security update.
3.2.1Update Checklist
We ask you to strictly comply with the checklist below when doing an update:
- Always do a backup for your database and your files in your shop
- Use always a test system to test the update process.
- Wait until all the files are copied to the shop, clear the cache if there is one in your shop and then visit the configuration page of the main module so that the update process will be initialized.
Please test the update procedure first in your test shop. Our support team is able and willing to help you if you experience problems with the update process. However, if you decide to perform the update directly in your live shop there is the possibility of a downtime of the shop of more than two days depending on the availability of our support if you do not want to book our complementary support.
Depending on the version it could be that the database has to be migrated. We recommend you therefore, to perform the updates in times when the shop is not visited too frequently by your customers.
3.2.2Update Instructions
Please always read the update instruction. Those instructions can be found in the changelog. If there are no special remarks, you can proceed by just overwriting the files in your system.
4Module Configuration in the OXID Shop
The configuration consists of two steps. The first step is the configuration of the main module with all the basic settings (cf. Configuration of the Main Module). During the second step you can then carry out individual configurations for each payment method . This allows for full flexibility and perfect adaptation to your processes.
Please create a backup of the main directory of your shop. In case of problems you will then always be able to return your shop to its original state.
We furthermore recommend testing the integration on a test system. Complications may arise with third party modules installed by you. In case of questions, our support is gladly at your disposal.
4.1Configuration of the Main Module
The settings for the main module can be found under Extensions > Module . Install the module by clicking Activate.
By clicking on the tab Settings you get to the configuration of the main module. Fill in the boxes by using the data that you have received from EMS eCommerce Gateway and may have already saved in the backend of EMS eCommerce Gateway. Each option is additionally explained in a short info text in the shop.
4.1.1Settings
4.1.1.1Update interval for payments
Payments may be updated periodically (interval in minutes). To use this feature you have to setup a cron job.
4.1.1.2Order Creation
Choose when the order should be created. If set to 'Before Payment', orders are created in any case. If set to 'After Payment', an order is created only if the payment is successful.
4.1.1.3Order ID
Use this setting to enforce the behaviour of unique order IDs, even if they are not.
Changing these settings may cause duplicate transaction ids to be distributed, which will cause errors during transaction processing. If you wish to change these after transactions have been created you must backup then empty the module transaction table in the database.
4.1.1.4Delete Orders on Failure
Set to yes to delete the order when the authorization fails. Otherwise the internal order status is set to 'PAYMENT_FAILED'.
4.1.1.5Logging Level
Messages of this or a higher level will be logged.
4.1.2OXID 6 Installation
After uploading the plugin via S/FTP, log into your server via SSH and navigate to the root folder of OXID. In this directory, run the following commands so the plugin is available in the backend:
command vendor/console/bin oe:module:install-configuration source/modules/customweb/emsecommercecw/
php vendor/bin/oe-console oe:module:activate emsecommercecw
php vendor/bin/oe-console oe:module:apply-configuration
4.2Configuration of the Payment Module
After having successfully configured the main module, you can find the settings for the individual payment methods in your shop under Shop Settings > Payment Methods . Each method is listed individually.
Install the payment methods you wish to offer your customers. Open the payment method and tick the box next to Active.
By clicking on EMS eCommerce Gateway Configuration, you can save different settings for each payment method and thereby optimally adapt the payment methods to your existing processes
Please check if you have attributed the payment method to the available countries as well as customer groups in case a should payment method not be visible in the checkout.
By choosing the authorization method Hidden Authorization, the insertion of the credit card data occurs in your shop. This requires additoinal PCI Certification though.
However, if you prefer that the customer inserts the credit card data on the payment page of EMS eCommerce Gateway, you have the possibility of placing your logo on said Payment Page. In order to do so, please contact EMS eCommerce Gateway directly.
4.3Direct Capturing of Transactions
The option "Capture" allows you to specify if you wish to debit payments directly or if you first wish to authorise them and then debit the payment at a later point.
Depending on your acquiring contract, a reservation is only guaranteed for a specific period of time. Should you fail to debit the payment within that period, the authorisation may therefore no longer be guaranteed. Further information on this process can be found below.
It may be that settings saved in the payment modules overwrite settings saved in EMS eCommerce Gateway.
4.4Uncertain Status
You can specifically label orders for which the money is not guaranteed to be received. This allows you to manually control the order before shipment.
4.4.1Setting the order state
For each payment method you may select in which state the order should be set to depending on the booking state. This is the initial state of the order.
4.5Optional: Validation
Note: It can be that this option is not visible in your module. In this case just ignore this section.
With the option 'Validation' you can define the moment when the payment method should be made visible to the customer during the checkout process. This setting is relevant for modules where the usage depends on the customer's compliance with specific preconditions. For example, if a solvency check has to be carried out or if the payment method is only available in certain countries. In order for the credit check or address validation to also work with European characters, the charset of the "Blowfish mode" must be set to "UTF-8" for certain PSP settings.
You have the choice between these options:
- Validation before the selection of the payment method: A validation verification is carried out before the customer selects the payment method. If the customer does not fulfill the requirements, the payment method is not displayed
- Validation after selection of the payment method: The verification of the compliance occurs after the selection of the payment method and before the confirmation of the order
- During the authorisation: The validation verification is carried out by EMS eCommerce Gateway during the authorisation process. The payment method is displayed in any case
5Settings / Configuration of Payment Methods
5.1General Information About the Payment Methods
The plugin contains the most common payment methods. In case a desired payment method is not included per default, please contact us directly.
In order to be able to use a payment method, it must be activated in your account with EMS eCommerce Gateway as well as in your shop. Information about the configuration of the payment methods can be found further above.
Below you can find important information for specific payment methods that deviate from the standard process.
5.2Information on Payment Status
For each payment method you can define an initial payment status (status for authorized payments etc.). You hereby define the payment status for each state depending on the processing type of the order (captured, authorized, etc.). It's the initial status which the order assumes. Depending on the mutation carried out by you, the status can change.
Never set the status to Pending EMS eCommerce Gateway or any similar pending status which is implemented by the module.
5.2.1Order status "pending" / imminent payment (or similar)
Orders with the status 'pending EMS eCommerce Gateway' are pending orders. Orders are set to that status if a customer is redirected in order to pay but hasn't returned successfully or the feedback hasn't reached your shop yet (Customer closed window on the payment page and didn't complete payment). Depending on the payment method these orders will automatically be transformed into cancelled orders and the inventory will be cleared (so long as the Cronjob is activated). How long this takes depends on the characteristics of the payment method and cannot be configured.
If you have a lot of pending orders it usually means that the notifications from your webserver to EMS eCommerce Gateway are being blocked. In this case check the settings of your firewall and ask the Hoster to activate the IPs and User Agents of EMS eCommerce Gateway.
5.2.2Order status "cancelled"
Orders with the status "cancelled" have either been set to that status automatically due to a timeout, as described above, or have been cancelled directly by the customer.
6The Module in Action
Below you will find an overview of the most important features in the daily usage of the EMS eCommerce Gateway module.
6.1Useful Transaction Information on the Order
In the tab EMS eCommerce Gateway Transactions you can find an overview of the transaction information. Among others, this information allows for the definite attribution of the orders to their corresponding transaction, seen in the backend of EMS eCommerce Gateway.
6.2Usage of the Alias Managers / Token Solution
With the Alias Manager, your customers can securely save their credit cards with EMS eCommerce Gateway for later purchases. You can enable this by activating the option "Alias Manager" in the configuration of the Payment Method. The customer can then choose from his or her saved credit cards without having to re-enter all the details.
The usage of the Alias Managers requires the activation of the correct option with EMS eCommerce Gateway. To do so, please contact the support directly.
6.3Capturing / Cancelling of Orders
Our module allow you to capture payments directly from within Oxid eSales without having to log into EMS eCommerce Gateway.
6.3.1Capturing Orders
In order to capture orders, open the transaction tab (EMS eCommerce Gateway Transactions). By clicking on the button Capture a new window will open up in which you can capture transactions.
You can now capture each item individually if you don't want to ship them all at once. The amount of possible partial captures depends on your contract. For more information on this, please contact EMS eCommerce Gateway directly.
The transaction management between your shop and EMS eCommerce Gateway is not synchronised. If you capture payments with EMS eCommerce Gateway, the status in the shop will not be updated and a second capturing in the shop is not possible.
I you do not want to capture all items of an orders, click on 'Close transaction for further captures'.
Please find out if the capturing of partial amounts is supported by your EMS eCommerce Gateway contract. If this is not the case, it might happen that no further captures can be carried out.
6.3.2Cancelling Orders
By clicking Cancel the transaction is cancelled and the amount reserved on the customer's card will be released immediately.
6.4Refunding Orders
In order to refund orders, open the transaction tab (EMS eCommerce Gateway Transactions) and click on Refund. A new window will open up.
You can refund every item individually or any amount of your choice by modifying the total amount to pay or the amount of items.
With our module it is not possible to refund more than 100% of the originally authorised amount.
Executing a refund will not change the status of the order.
6.5Setup a Cron Job to Activate the Timed Operations
To activate the timed operations of the plugin (e.g. update service, deleting pending orders, etc.) make sure that you set up the OXID Cron engine. Especially the update function allows you to automatically retrive additional information or changes of your order directly via the API of EMS eCommerce Gateway. Please note it could be that in order to use the update feature it may be necessary that EMS eCommerce Gateway activates additional options in your account.
In order to use the timed operations, please schedule a cron job in your server to the following controller:
http://urltoyourstore.com/index.php?cl=emsecommercecw_cron
Here we suggest you use a Cron Engine like for example EasyCron. That way you can This allows you to open the file ( URL ) with an external service.
7Testing
Before switching from test to live mode it is important that you test the module extensively.
Do not forget to switch the operating mode from test to live after having successfully tested the module.
7.1Test Data
In the following section you can find the test data for the various payment methods:Card number 5404 1070 0002 0010 Expiry Date 12/2020 CVC 123 |
Card number 4921 8180 8989 8988 Expiry Date 12/2020 CVC 123 |
Card number 4921 8180 8989 8988 Expiry Date 12/2020 CVC 123 | |
Card number 5404 1070 0002 0010 Expiry Date 12/2020 CVC 123 |
8Errors and their Solutions
You can find detailed information under http://www.sellxed.com/en/faq. Should you not be able to solve your problem with the provided information, please contact us directly under: http://www.sellxed.com/en/support
8.1The Referrer URL appears in my Analytics Tool
When a customer and the notification are redirected via Header Redirection, the EMS eCommerce Gateway Referrer URL might appear in your Analytics Tool thus hiding the original traffic source. However, most Analytic Tools are able to minimize this problem.
In case you are using Google Analytics as reporting tool, this step by step guide may help you to exclude the URLs: under bullet point 4.
9Compatibility with Third-Party Plugins
The plugins listed below are compatible with our payment modules and allow you to handle certain tasks in an easier way.
9.1Birthday and gender in OXID
For certain payment service providers it is necessary to check the birthday and the gender of a customer. OXID does not check this by default. These checks can be enabled under "Settings > Other Settings > Mandatory fields in User Registration Form".
10Error Logging
The module will log different unexpected errors or information depending on the configured level. If there is any issue with the module, this log can help identify the cause.
10.1Log Levels
You can configure the log level in the EMS eCommerce Gateway settings.
- Error: Logs unexpected errors only. (Default)
- Info: Logs extended information.
- Debug: Logs information helpful for debugging.
10.2Log Location
The log file is stored in the OXID log directory. Please make sure the folder and it is writable by the webserver. (Default Path: {shopRootDirectory}/logs/)
11Advanced Information
This section of the manual is for advanced usage of the module. The content is for advanced users with special requirements. Everything in this section is optional and not required for the daily usage of the module.
11.1Transaction Object
This section describes how to extract information from a transaction, if you need it for further processing. E.g. you require more information of the transaction for further processing an order in your ERP system.
The code snippets in this section assume your script resides in the root folder of the shop with the default shop folder structure.
require_once dirname(__FILE__) . "/bootstrap.php";
require_once 'modules/customweb/emsecommercecw/classes/EMSeCommerceCwHelper.php';
$transactionById = EMSeCommerceCwHelper::loadTransaction(transactionId); $transactionObject = $transactionById->getTransactionObject();