1Introduction

This manual leads you through the installation, configuration and usage of the payment module for WooCommerce 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.

1. Configuration of the basic settings of the payment module
2. Configuration of the payment methods
3. Carrying out a test purchase by means of the attached test data at the end of this document

1.2System Requirements

• 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):

• https://www.ipg-online.com/emea/login.jsp?lng=de_DE.

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.

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:

1. Open the certificate (file with the extension .pem)
2. Open the key simultaneously (file with the extension .key)
3. Insert the content of the key underneath the certificate file
4. Save the certificate file and copy it into: /files/woocommerce_emsecommercecw/libCustomweb/EMSeCommerce/Certificates/Default/
5. 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 WooCommerce 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:

1. Download the plugin. The download can be found in your sellxed.com account under "My Downloads".
2. Unzip the archive you have just downloaded.
3. In the unzipped folder navigate to the folder "files"
4. 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.
5. 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.
6. 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:

1. Always do a backup for your database and your files in your shop
2. Use always a test system to test the update process.
3. 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.

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 WooCommerce 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.

4.1Configuration of the Main Module

You can activate the plugin by clicking "activate" under the module WooCommerce EMS eCommerce Gateway in the menu Plugins.

After the Installation of the plugin a new menu on the dashboard will appear called EMS eCommerce Gateway . Enter all data in the corresponding fields. Each option is, furthermore, explained in short info texts in the shop.

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 WooCommerce > Settings > Checkout (In earlier version it was WooCommerce > Settings > Payment Gateways). Each payment method is listed individually. Install the payment methods you wish to offer to your customers. You can carry out individual settings for each payment method and thereby optimally adapt the payment methods to your existing processes. The most central options are described in more detail further below.

By clicking on Enable the payment method is activated in your shop. For more detailed information on the settings, please refer to information provided directly within the module configuration.

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.

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

4.6Redirection / Payment Form Error

If the successful redirection to the payment page suddenly stops working or you are only able to see the header and footer of your template instead of the payment form, you might be affected of the following issue. As a first step, you should update your payment plugin to the latest version, deactivate it in the backend of WooCommerce and activate it again.

If you are using WPML it can happen that the page for the redirection of the customer to EMS eCommerce Gateway payment page results in a '404 Page Not Found' error. In this case, you will have to duplicate our checkout page under 'Pages' in the corresponding languages. In order to do so please follow these steps:

1. Go to the WooCommerce backend and select: Pages > All Pages. There you should find a Page called "EMS eCommerce Gateway Checkout".
2. Delete all existing pages called “EMS eCommerce Gateway Checkout”.
3. In the plugin section of your Wordpress dashboard, deactivate the WooCommerce EMS eCommerce Gateway plugin and activate it again. This will help you to generate a new redirection page.
4. Navigate again to Pages > All Pages. Open the configuration of the new redirection page.
5. On the right hand side under 'languages' you can now duplicate the content of this page for all of your installed languages. When you have successfully saved the changes, this page will be active for all of your languages and the error should have disappeared.

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.

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

You can find an overview of the transaction information in within the order detail view. Among others, this information allows for the definite attribution of the orders to their corresponding transaction, seen in the backend of EMS eCommerce Gateway.

Figure 6.1: Transaction Information in WooCommerce.

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.

Figure 6.1: Alias Manager in WooCommerce

6.3Capturing of Orders

In order to be able to capture orders you must make sure that you have set the option 'Capturing' to 'deferred' in the payment method configuration.

Open the order and look for the EMS eCommerce Gateway transaction tab at the bottom. Capturing via the internal operation of WooCommerce is not supported.

Figure 6.1: Transactiondetails in the transaction tab of a specific order.

Click on "More Details" to view the transaction details. By clicking Capture button, you get into the following context.

Figure 6.1: Deferred/Manual capture of transactions within WooCommerce

Enter the amount of your choice that you wish to capture from the customer's card. By clicking Capture a direct capturing of the order occurs with EMS eCommerce Gateway.

Please be aware that cancelling the transaction does not cause a status change of the order.

6.4Refunds

You can refund already captured transactions and automatically transmit them to EMS eCommerce Gateway.

Figure 6.1: Transactionsdetails via Orders > EMS eCommerce Gateway Transactions.

By clicking Refund button, you get into the following context.

Figure 6.1: Refund of transactions within WooCommerce

Just like for the capturing, you open the order and click on the magnifying glass next to the order of your choice. Enter any refund amount of your choice in the field provided for this purpose. By clicking refund the refund request will directly be sent to EMS eCommerce Gateway and the specified amount will be credited on the customer's credit card.

Please note that you can't refund more than 100% of the original amount.

Furthermore, please be aware that processing a refund will not cause a status change of the order.

6.5Transaction Process

Each action affiliated with transaction management is logged by the module.

Figure 6.1: Transactions in the Overview of the Transaction Process

6.6Setup 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 WooCommerce 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.

The module uses the standard cron engine of WooCommerce. More infromation regarding the set up can be found here.

7Testing

Before switching from test to live mode it is important that you test the module extensively.

7.1Test Data

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.1Page Not Found Error prior to the redirection to Payment Page

If you are using WPML it can occur that the Pages for the display of the payment methods or for the redirection to EMS eCommerce Gateway end in a Page Not Found Error.

In this case you have to duplicate our Pages in the corresponding languages. In order to do so please follow these steps:

1. Go to the main menu and select Pages > All Pages. There you should find a Page called EMS eCommerce Gateway Checkout.
2. Open the configurations.
3. On the right hand side under languages you can now duplicate the content of this page for all of your installed languages. When you have successfully saved the changes this page will be active for all of your languages and the Error should have disappeared.

8.2The 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.1Fee's and discount's within WooCommerce

To configure a EMS eCommerce Gateway payment gateways based fee and discount you will need the following 3rd-Party plugin.

• Checkout Fees for WooCommerce

9.2Multilingual WooCommerce sites

To run multilingual WooCommerce sites you will need the following 3rd-Party plugin.

• WPML for WooCommerce

9.3Birthday and gender in WooCommerce

For certain payment service providers it is necessary to check the birthday and the gender of a customer. WooCommerce does not check this by default.

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 wp-content/uploads/wc-logs. Please make sure the path exists and it is writable by the webserver.

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__) . '/wp-load.php' );

require_once ABSPATH.'wp-content/plugins/woocommerce_emsecommercecw/classes/EMSeCommerceCw/Util.php';

$transactionById = EMSeCommerceCw_Util::getTransactionById($transactionId);
$transactionObject = $transactionById->getTransactionObject();

$transactionByExternal = EMSeCommerceCw_Util::getTransactionByTransactionNumber($externalId);
$transactionObject = $transactionByExternal->getTransactionObject();

$transactionsByPostId = EMSeCommerceCw_Util::getTransactionsByPostId($orderId);
foreach($transactionsByPostId as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}