1Introduction

This manual leads you through the installation, configuration and usage of the payment module for OXID and Sogenactif 2.0.

Before beginning with the installation, please make sure that you are in possession of all necessary data:

• Access to your merchant account of Sogenactif 2.0 (https://telechargement.sogenactif.com) - On this plattform you can download the access information.
• OXID payment module from sellxed.com/shop.
• Access to your server.

In case you don't yet have a contract with Sogenactif 2.0, we please ask you to contact their support.

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 important information for the installation of the module. It is important that you strictly follow the checklist. Only by doing so, can a secure usage in correspondence with all security regulations be guaranteed.

1. Configuration of the basic settings of the payment module
2. Configuration of the payment methods
3. Carrying out of a test purchase by means of the attached test data at the end of this document
4. If your test was successful, do not forget to switch the operating mode to live mode.

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 of the Payment Module and the Payment Methods

In order to configure and set up the main module in OXID please double check that you received the following information:

• Live Merchant ID
• Live Secret Key
• Live Secret Key Version

All this informations are provided in the Sogenactif 2.0 merchant account. Click on the button located on the top right hand corner of the page called SECRET KEY.

Figure 2.1: Access to the secret keys.

Follow the instruction in the section main module to install and set the above retrieved credentials directly in your shop. If you want to have additional information regarding how to use the Extranet of Sogenactif 2.0 we ask you kindly to directly call the customer support of Sogenactif 2.0.

3Payment Plans

You are able to split a payment at Sogenactif 2.0 in order to charge the total amount to your clients in several steps. The remaining payments are directly charged to your customers by Sogenactif 2.0 - You do not have to do anything yourself to debit their cards for later payments. By default your account is able to split payments in 2 or 3 payments. Please contact the support desk of Sogenactif 2.0, if you wish to setup more than 2 or 3 n-Payments and activate the feature in your account. You'll need to make sure to follow the following two steps in order to activate the payment plans in your shop.

• You need to activate the payment plans option within any payment method. This setting can be found in the settings of any payment method within your shop administration.
• In the setup file of Sogenactif 2.0 within your shop, you will find the section 'Payment Plans' ('Paiement n-fois'). This is where you'll need to setup your payment plans.

Figure 3.1: A payment plan in the setup file of Sogenactif 2.0.

4Migrating from Version 1 to Version 2

Sogenactif 2.0 will be deprecating Version 1 of it's API by end of year 2021. You can continue to use API Version 1 until this date but it is recommended to make the switch before then. In order to do this please contact your payment provider and ensure they have configured your merchantId to use Version 2 and set up a secret Key to your existing MerchantID.
Once this process is complete enter your new merchant details (as outlined above in the configuration section). Once you have done this ensure you have chosen "2" from the API version dropdown. If you have not chosen this configuration option you will receive the following error message:

Figure 4.1: The api version dropdown for Sogenactif 2.0.

5Module Installation and Update in the OXID Shop

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

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

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

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

6Module 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.

6.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 Sogenactif 2.0 and may have already saved in the backend of Sogenactif 2.0. Each option is additionally explained in a short info text in the shop.

6.1.1Settings

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

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

6.1.1.3Order ID

Use this setting to enforce the behaviour of unique order IDs, even if they are not.

6.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'.

6.1.1.5Logging Level

Messages of this or a higher level will be logged.

6.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/sogenactifcw/

php vendor/bin/oe-console oe:module:activate sogenactifcw

php vendor/bin/oe-console oe:module:apply-configuration

6.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 Sogenactif 2.0 Configuration, you can save different settings for each payment method and thereby optimally adapt the payment methods to your existing processes

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

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

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

6.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 Sogenactif 2.0 during the authorisation process. The payment method is displayed in any case

7Settings / Configuration of Payment Methods

7.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 Sogenactif 2.0 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.

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

7.2.1Order status "pending" / imminent payment (or similar)

Orders with the status 'pending Sogenactif 2.0' 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 Sogenactif 2.0 are being blocked. In this case check the settings of your firewall and ask the Hoster to activate the IPs and User Agents of Sogenactif 2.0.

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

8The Module in Action

Below you will find an overview of the most important features in the daily usage of the Sogenactif 2.0 module.

8.1Useful Transaction Information on the Order

In the tab Sogenactif 2.0 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 Sogenactif 2.0.

Figure 8.1: Transaction Information in OXID

8.2Usage of the Alias Managers / Token Solution

With the Alias Manager, your customers can securely save their credit cards with Sogenactif 2.0 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 8.1: Alias Manager Integration in OXID eSales

8.3Capturing / Cancelling of Orders

Our module allow you to capture payments directly from within Oxid eSales without having to log into Sogenactif 2.0.

8.3.1Capturing Orders

In order to capture orders, open the transaction tab (Sogenactif 2.0 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 Sogenactif 2.0 directly.

I you do not want to capture all items of an orders, click on 'Close transaction for further captures'.

Figure 8.1: Capturing of Orders in OXID eSales.

8.3.2Cancelling Orders

By clicking Cancel the transaction is cancelled and the amount reserved on the customer's card will be released immediately.

8.4Refunding Orders

In order to refund orders, open the transaction tab (Sogenactif 2.0 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.

Figure 8.1: Refunds in OXID eSales for Sogenactif 2.0.

Executing a refund will not change the status of the order.

8.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 Sogenactif 2.0. Please note it could be that in order to use the update feature it may be necessary that Sogenactif 2.0 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=sogenactifcw_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.

9Testing

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

9.1Test Data

10Errors 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

10.1The Referrer URL appears in my Analytics Tool

When a customer and the notification are redirected via Header Redirection, the Sogenactif 2.0 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.

11Compatibility 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.

11.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".

12Error 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.

12.1Log Levels

You can configure the log level in the Sogenactif 2.0 settings.

• Error: Logs unexpected errors only. (Default)
• Info: Logs extended information.
• Debug: Logs information helpful for debugging.

12.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/)

13Advanced 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.

13.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/sogenactifcw/classes/SogenactifCwHelper.php';

$transactionById = SogenactifCwHelper::loadTransaction(transactionId);
$transactionObject = $transactionById->getTransactionObject();