1Introduction

This manual describes the installation, the configuration and the use of the payment module forOpenCart and paydirekt.

Before you begin with the installation make sure you have all the necessary data:

  • You need an Owner Account for paydirekt for the Sandbox and / or the Live Account. You will receive this account directly from paydirekt.
  • You need thepaydirekt payment module from www.sellxed.com/shop.

In case you don't have a contract with paydirekt yet, we will gladly provide you with one.

1.1Installation Procedure

This document provides you with all the necessary information regarding the installation of the module. You should follow the steps of the checklist carefully during the startup procedure. Only by doing so, the safe use in compliance with all the safety regulations can be ensured..

  1. Configuration of the Sandbox and creating the technical accounts.
  2. Configuration of the payment methods and the basic settings.
  3. Carrying out a test order by means of the enclosed Test data at the end of this document.
Installation Service

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

.htaccess Directory Protection

In order to test the module, any kind of directory protection or IP blocking on your server must be deactivated. This is crucial; otherwise the payment feedback of paydirekt might not get through to the shop.

1.2System Requirements

In general, the plugin has the same system requirements as OpenCart. 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.

In case you are using OpenCart version 3.0.3.5 or 3.0.3.6, you must patch your store to fix the twig extension error in order for modified templates to be loaded. The following extension can be used to resolve the issue: https://www.opencart.com/index.php?route=marketplace/extension/info&extension_id=40469.

2Configuration paydirekt

2.1Sandbox and Live Platform for the Administration

You will find the administration and the display of the transactions, depending on the operating mode, via the following links. You need the Sandbox for the test payments.

2.2Configuration of the API Keys

If the test was successful repeat these steps for the live platform.

2.2.1Creating a Technical User

Log in at https://sandbox.paydirekt.de/merchant/ with the received access data. At Settings > User Administration you can add a new user or change existing rights. Add a new user or make sure that your Owner Account contains the functions Reporting, Reverse Transaction, Technician

To make the changes effective you need to log out and in again.

Figure 2.1: Edit the user role (icon).

2.2.2Generating API Keys and Secrets

When you log in you will find the API Keys under "Settings". Here you can generate a new API Key and a Secret Key. The API Key and the Secret Key will be shown to you once. Transfer the data directly into the main module.

Figure 2.1: Generating API Keys (Icon).

2.2.3Logo

Under Settings you can also upload your logo. The logo will be displayed in the e-mails and during the payment transaction.

2.2.4Transaction List

You now have access to the transactions on your home page. Please note that failed transactions won't be listed in the transaction list. You can also refund transactions from here. We recommend you don't do so via your shop though. Payments that you transfer back via the back end won't be synchronized with the shop and can't be refunded there anymore.

Figure 2.1: Transaction Overview

2.3Configuration of the Main Module

Navigate to the main module in your shop. Please fill in the following data into the corresponding sections:

  • API Key (previously created by you)
  • API Secret (previously created by you)

Save the data according to live or test mode.

2.4Activating the Payment Methods and Testing

Next you need to activate the payment method and run a test. Further information concerning the configuration of the payment methods and the meaning of each setting can be found here.

When you have activated the configuration of the payment methods you will run a test by means of the published test data in the manual. If all the tests were successful, switch the operating mode in the main module to Live.

3Module Installation and Update in the OpenCart 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 shops 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 thats 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 back up 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.
Do not do updates directly in the live environment

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. They can be found on the plugin page in the shop under the section change log on the lower end of the page. If there are no special remarks, you can proceed by just overwriting the files in your system

4Module Configuration in the OpenCart 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.

Create back-ups!

Please create a back-up 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.

5OpenCart 1.5.x / 2.0 / 3.0 Installation - Additions

All our modules are compatible with OpenCart 2.0. If you use OpenCart 2.0 upload all the files in the folder files_2.x to the root folder of your shopping cart. In case you are using OpenCart 1.5.x as basis you should use the folder files_1.x

In order to guarantee smooth operations and the usage of all features please make sure that you follow the instructions below.

5.1Configuration of the Main Module

You will find the settings for the main module under "Extension > Modules > paydirekt Base Module" . Install the module by clicking Install.

By clicking Edit you can configure the main module. Enter all data in the corresponding fields. The required data has either already been saved in the back-end of paydirekt has been sent to you by paydirekt. Each option is, furthermore, explained in short info texts in the shop.

5.2Opencart 2.0 / 3.0 - Refresh Modifications

In case you are using OpenCart 2.0 you will have to refresh the modifications. Go to Module > Modifications. and click on the refresh button in the top right corner. Make sure that the folder system > modification is writable.

5.3OpenCart 1.0 Specifications

In case you are using OpenCart 1.0 you should make sure that you use VQMOD in order to be able to use the whole set of functionalities. More Information about the project and the installation can be found under: https://github.com/vqmod/vqmod/wiki/Installing-vQmod-on-OpenCart

5.4Configuration 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 Extensions > Payments . 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 Install the payment method is activated in your shop. Click Edit in order to modify the configuration of the payment method.

5.5Shop ID

In the case of a multi-store set up (cf. chapter: Multi-Store), the parameter Shop ID identifies the shop's request and, therefore, redirects the feedback of paydirekt based on the shop ID.

5.6Order Prefix

With the option order prefix you can define your own order scheme for the transmission to paydirekt. This option helps you identify to which shop a transaction the back-end of paydirekt is related to. The tag "{id}" will automatically be replaced be the consecutive order number.

5.7Selecting the Authorisation Method

You can choose between two options of authorizing credit card payments. By selecting one of the two under the option 'Authorisation Methods', you define how you want to process the individual payment methods.

Further information on the various authorisation methods can be found on our sellxed website.

Payment Processing

Please pay attention to the fact that you require the activation of further options with paydirekt in order to use some of the authorisation methods.

It may be that certain authorization methods are not available for every payment method.

Alongside the introduction of PCI 3 there are additional certification requirements in case you are using the authorization method Hidden or AJAX. Please contact paydirekt for further information or switch to another authorization method.

5.8Direct 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 the debit the payment at a later point.

Depending on your acquiring contract, a reservation is only guaranteed for a specific amount 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.

Different settings between paydirekt and the module

It may be that settings saved in the payment modules overwrite settings saved in paydirekt.

5.9Uncertain Status 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.

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

5.10Optional: 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. 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 he or she 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 paydirekt during the authorisation process. The payment method is displayed in any case

5.11Multi-Shop Set-Up

The payment module is designed for the usage of one paydirekt contract for several shops. It must be differentiated, however, between the case of an integrated multi-shop functionality and independent shops:

Figure 5.1: Multi-shop set-up
Licensing

In the case of independent shops, you require a payment module license for each shop. For scale prices, please contact us directly.

6Settings / Configuration of Payment Methods

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

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

Important info regarding Order Status

Never set the status to Pending paydirekt or any similar pending status which is implemented by the module.

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

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

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

7The Module in Action

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

7.1Useful Transaction Information on the Order

You can find an overview of the most important transaction information in all orders that have been processed by our module. Among others, this information allows for the definite attribution of the orders to their corresponding transaction, seen in the back-end of paydirekt.

Figure 7.1: Transaction Information in OpenCart.

7.2Capturing / Cancelling of Orders

7.2.1Capturing Orders

In order to capture orders, open the transaction manager under Sales > paydirekt Transactions. Here you will find an overview over all transactions. Search for the order in the field with the order numbers. By clicking "view" you will open the transaction of the order.

7.2.1.1Capturing Complete Orders or Partial Capturing

By clicking the button "Capture Transaction" a new window opens up. You can now capture every item individually in case you do not wish to send all items at once. The amount of possible partial captures depends on your contract. Please contact paydirekt directly in order to clarify questions.

Capturing of Orders in the Back-End of paydirekt

The transaction management between your shop and paydirekt is not synchronised. If you capture payments with paydirekt, the status in the shop will not be updated and a second capturing in the shop is not possible.

In case you do not wish to capture all items of an order, you can close the transaction by clicking the box.

Figure 7.1: Capturing of Orders
Partial Capturing

Please find out if the capturing of partial amounts is supported by your paydirekt contract. If this is not the case, it might happen that the transaction is closed for further transactions after a partial capture.

7.2.2Cancel Orders

By clicking "Cancel Transaction", the transaction is cancelled and the reserved amount on your customer's card is released automatically.

Figure 7.1: Capture or Cancel in OpenCart.

7.3Refunding Orders

In order to refund orders, open the transaction information (cf. above).

You can refund individual items or any amount of your choice by modifying the total amount or the item quantity.

Figure 7.1: Refunds in OpenCart for paydirekt.
Maximal Refund

With our module it is not possible to refund more than 100% of the originally authorised amount.

7.4Set-up 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 OpenCart Cron engine. Especially the update function allows you to automatically retrive additional information or changes of your order directly via the API of paydirekt. Please note it could be that in order to use the update feature it may be necessary that paydirekt 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:

https://www.your-shop.com/index.php?route=paydirektcw/cron/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.

8Testing

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

Testing

Do not forget to switch the operating mode from test to live after having successfully tested the module.

8.1Test Data

In the following section you can find the test data for the various payment methods:
paydirekt
User
SDE-Kaeufer
Password
SDE-Kaeufer2$
Standard Payer
User
unterAchtzehn
Password
unterAchtzehn2$
Age - Payer under 18 years
User
KaeuferGesperrt
Password
KaeuferGesperrt2$
Payer blocked at PayDirekt
User
SperreKB
Password
SperreKB2$
Payer blocked at Bank

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

9.1The Referrer URL appears in my Analytics Tool

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

10Compatibility with Third-Party Plugins

The plugins listed below are compatible with our payment modules and allow you to handle certain tasks in a easier way.

10.1Birthday and gender in OpenCart

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

How to enable gender and birthday checks in your shops checkout
  1. Add two new custom fields to your checkout via your shops backend under "Customers > Custom Fields"
  2. Modify the order context getters to return the value of your custom checkout field from the order / session (or wherever the previous step saves the data).

    Order Context Getters

    • AbstractOrderContext
    • getBillingDateOfBirth()
    • getBillingGender()

    These functions can be found in "system/library/cw/PayDirekt/AbstractOrderContext.php".

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

11.1Log Levels

You can configure the log level in the paydirekt settings.

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

11.2Log Location

The log file is stored in the default log folder of OpenCart. The path is configured in the config.php of your shop system. (Default Path: {shopRootDirectory}/system/logs or {shopRootDirectory}/system/storage/logs)

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

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

In your script initialize the base of OpenCart.
Opencart 1.x
require_once('config.php');

require_once(DIR_SYSTEM . 'startup.php');

require_once(DIR_SYSTEM . 'library/customer.php');
require_once(DIR_SYSTEM . 'library/affiliate.php');
require_once(DIR_SYSTEM . 'library/currency.php');
require_once(DIR_SYSTEM . 'library/tax.php');
require_once(DIR_SYSTEM . 'library/weight.php');
require_once(DIR_SYSTEM . 'library/length.php');
require_once(DIR_SYSTEM . 'library/cart.php');

$registry = new Registry();
$loader = new Loader($registry);
$registry->set('load', $loader);
$config = new Config();
$registry->set('config', $config);
$db = new DB(DB_DRIVER, DB_HOSTNAME, DB_USERNAME, DB_PASSWORD, DB_DATABASE);
$registry->set('db', $db);
Opencart 2.x
require_once('config.php');
require_once(DIR_SYSTEM . 'startup.php');
// Registry
$registry = new Registry();

// Config
$config = new Config();
$config->load('default');
$config->load('catalog');
$registry->set('config', $config);
$loader = new Loader($registry);
$registry->set('load', $loader);
$registry->set('db', new DB($config->get('db_engine'), $config->get('db_hostname'), $config->get('db_username'), $config->get('db_password'), $config->get('db_database'), $config->get('db_port')));
Opencart 3.x
require_once('config.php');
require_once(DIR_SYSTEM . 'startup.php');
// Registry
$registry = new Registry();

// Config
$config = new Config();
$config->load('default');
$config->load('catalog');
$registry->set('config', $config);
$loader = new Loader($registry);
$registry->set('load', $loader);
$registry->set('db', new DB($config->get('db_type'), $config->get('db_hostname'), $config->get('db_username'), $config->get('db_password'), $config->get('db_database'), $config->get('db_port')));
Include the module specific files and set registry.
require_once DIR_SYSTEM.'library/cw/init.php';
require_once DIR_SYSTEM.'library/cw/PayDirektCw/Util.php';
require_once DIR_SYSTEM.'library/cw/PayDirektCw/Entity/Transaction.php';
PayDirektCw_Util::setRegistry($registry);
Now you can load the transaction and then extract the transactionObject.
Load the transaction by Id:
$transactionById = PayDirektCw_Entity_Transaction::loadById($transactionId);
$transactionObject = $transactionById->getTransactionObject();
Load transactions by Order ID:
$transactionsByOrderId = PayDirektCw_Entity_Transaction::getTransactionsByOrderId($orderId);
foreach($transactionsByOrderId as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}