1Introduction

This manual describes the installation, the configuration and the use of the payment module forMagento and giropay / paydirekt.

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

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

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

Note that you must use at least PHP version 5.6 for our plugins. PHP 8 or higher is currently not supported.

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.

1.2System Requirements

• PHP Version: 5.4.x or higher
• Magento: 1.7.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 giropay / 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.

• Sandbox:https://sandbox.paydirekt.de/merchant/.
• Live-Platform:https://www.paydirekt.de/merchant/.

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

In the following you will find the installation manual for Magento 1 as well as Magento 2

3.1.1Magento 1

1. Create a back-up of your shop.
2. Extract the content of the ZIP file.
3. Copy the entire content of the folder "files" into the main directory of the server of your shop respectively to the folder where the plugins are copied normally. In order to do so, use your usual ftp program. Make sure that the folders aren't replaced but merely merged.

3.1.2Magento 2

Im Folgenden werden die Schritte für die Installation und das Update der Extensions erklärt.

3.1.2.1Installations Requirements

Bitte beachten Sie, folgende Voraussetzungen sind für den Betrieb von Magento 2 zwingend zu erfüllen:

1. System requirements von Magento (http://devdocs.magento.com/guides/v2.0/install-gde/system-requirements.html)
2. Der Cron Job muss korrekt eingerichtet sein, sonst können keine Extensions installiert werden. Weitere informationen fidnen Sie hier: http://devdocs.magento.com/guides/v2.0/config-guide/cli/config-cli-subcommands-cron.html

3.1.2.2Installation

For the installation of the plugin in your Magento 2 store please follow these steps:

1. Readiness Check

   Before uploading the plugin it is necessary to do the Readiness Check for Magento 2

   1. 1. Save this script as cw-setup.php on your copmuter.
   2. 2. Upload this cw-setup.php Script into the root directory of your Magnto 2 installation.
   3. 3. Access your server via SSH and run this command: php cw-setup.php
   4. 4. The script will present you with additional commands which you need to execute.

   About the cw-setup.php script

   The provided script generates a set of commands which should be executed to clean up Magento 2. The script itself doesn't execute anything. It only generates the necessary commands.

2. Upload

   Upload the content of the folder files_2 into the root directory of your server. Execute the commands provided by the cw-setup.php script again.

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.

3.2.2.1Magento 1

1. Download the newest version of the plugin. The download is available in your sellxed.com account under "My Downloads".
2. Extract the ZIP file.
3. Upload the folder files_1into the root directory of your shop.
4. Clear the Magento cache

3.2.2.2Magento 2

1. Download the newest version of the plugin. The download is available in your sellxed.com account under "My Downloads".
2. Extract the ZIP file.
3. Upload the folder files_2into the root directory of your shop.
4. Clear the Magento cache

3.3Database Migration

This section describes how you can run the database migration script

This only needs to be done if your Magento installation shows error messages regarding missing tables or columns in the database.

3.3.1Magento 1

Clear the Magento cache

If this does not resolve the issue, remove the entry paydirektcw_setup from the core_resource table and clear the cache again.

3.3.2Magento 2

From the command line run the following command:

php bin/magento setup:upgrade

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

4.1.1Magento 1

The settings for the main module can be found under System > Configuration > giropay / paydirekt. Enter the various options, some of which you have already specified in the configuration with giropay / paydirekt. Information on the functionalities as well as the impact of the individual settings can be found directly by the option.

The field "Time-Out for pending Payments" defines after how many minutes the order status should switch from pending to cancelled (0 means that nothing should be changed) if no successful feedback concerning the payment is received from giropay / paydirekt. This might occur e.g. if the customer has closed his or her browser. Further information on this topic can be found under Order Status.

4.1.2Magento 2

You will find the settings of the main module via Stores > Configuration > Sales > giropay / paydirekt > General.

Fill in the fields according to the configuration of giropay / paydirekt or with the data which you received directly from giropay / paydirekt. You can find more exact explanations regarding each option in the help text by the input boxes.

Figure 4.1: Magento 2: Configuration of the basic module. Please note, that this is an example and the settings can differ.

4.2Configuration of the Payment Method

4.2.1Magento 1

After having successfully installed the main module, you will find the individual payment modules under System > Configuration > Payment Methods. You can save 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.

4.2.1.1Direct Capturing of Invoices

The "Invoice Creation" specifies if invoices should be captured directly or not. Captured invoices can no longer be modified. If you wish to be able to modify the ordered article for debiting, please set this option to "Deferred".

4.2.2Magento 2

After having successfully configured the main module, you will find the settings for each payment method in your shop via Stores > Sales > Payment Methods. For each payment method you can change the settings individually to optimize the payment processing in your shop.

4.2.2.1Accounting

For each payment method you need to choose whether you want to register directly or delayed. A delayed booking only reserves the amount. Therefore it is important that you follow the instructions for such transactions as listed below. Reservations are usually only valid for a few days so we recommend to register directly. The delayed booking isn't available for every payment method.

4.2.2.2Authorization Method

For some payment methods you can choose between different authorization methods. The authorization method determines how the payment form is presented in your shop. Please note that for some authorization methods with credit cards there are extended PCI requirements. (https://www.sellxed.com/en/blog/pci-300-changes).

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 giropay / paydirekt during the authorisation process. The payment method is displayed in any case

4.5.1Usage of the Integrated Multishop Functionality of Magento

The payment module supports the multishop feature of Magento. No further modifications are necessary. The module automatically recognises the shop the order belongs to. In order for the multishop functionality to work, it is, however, necessary that the individual sub-shops within Magento have been configured correctly.

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

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 giropay / 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 giropay / 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 giropay / paydirekt.

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 giropay / paydirekt module.

6.1Capturing / Cancelling of Orders

6.1.1Magento 1

6.1.1.1Case 1: Invoice Capturing Directly After the Order

In the following, the process is explained for the case that you have chosen to directly create the invoice after having placed the order and only authorise payments - not capture them directly - (further information on the configuration can be found under Creating the Invoice).

In order to capture the order, open the invoice and click "capture". If you click "Cancel", the authorisation will be cancelled.

6.1.1.2Case 2: Deferred Invoice Capturing

In case you have chosen the deferred invoice creation, you first have to create the invoice by clicking on the button "Invoice". Select "Capture online" below the total amount and then click on "capture invoice". The invoice has now been captured.

6.1.1.3Cancel of orders/transactions

In order to cancel a transaction you first have to open the invoice and click on the cancel button. After that open the order and click on cancel here again. This will send the cancel of the order to giropay / paydirekt. Please note that you need to cancel the invoice and the order.

6.1.2Magento 2

6.1.2.1Capture Bug in Magento (v. 2.0.0)

In version 2.0.0 of Magento there is a bug. It could be that invoices cannot be captured. Please make the following adjustments in the file /vendor/magento/module-sales/Controller/Adminhtml/Order/Invoice/Capture.php:

1. Delete the lines in the picture bellow which begin with a - .
2. Add the lines which has been marked with a + .

Here you can find the codes to be inserted in the form of a text:

+ )->addComment( __('The credit memo has been created automatically.') );

Figure 6.1: Opening the Invoice

6.1.2.2Performing Captures

In the configuration of the payment method you can decide whether the invoice should be captured after having been created or if only the payment is authorized. You also decide if you already want to create an invoice. If you create an invoice you can't make any adjustments for the capture.

In order to capture invoices please take the following steps:

1. Open the order and create an invoice.
2. If you have set the Invoice Settlement to deferred you can still make adjustments to the invoice.
3. Click on Capture Online.

Figure 6.1: Capture options

6.1.2.3Cancelling / Voiding Orders

In order to issue a cancellation of the payment you must use the "Void" button. If you wish to use the "Cancel" button you must cancel the payment in the giropay / paydirekt backend portal.

6.2Refunds

6.2.1Magento 1

You can refund already captured transactions and automatically transmit them to giropay / paydirekt. In order to do so, open the invoice of the captured order. By clicking on "Credit Memo" the window for refunds is opened. Enter the amount you wish to refund. By clicking on "Refund" the refund is transmitted to giropay / paydirekt.

Below you find a step-by-step guide including screenshots:

Figure 6.1: 1. open the invoice

Figure 6.1: 2. click on credit memo - Important - open the invoice first!.

Figure 6.1: 3. Adjust the refunding amount (see more info below Refunds Based on Quantity)

Figure 6.1: 4. To process the refund click on Refund.

Figure 6.1: Wait for the confirmation of the refund.

6.2.1.1Refunds Based on Quantity

You can make refunds based on product quantity. In order to do so, open the credit memo window and enter the amount of products you wish to refund to your customer's card

You can carry out as many individual refunds as you wish until you have reached the quantity of the original order. The status of the order then automatically switches to complete.

Figure 6.1: Overview of all Refunds

6.2.1.2Refunding of Any Amount

As each position of the order needs to be transmitted to giropay / paydirekt we can't support the function Adjustment Refund - meaning the refund of any amount. Only whole items can be refunded by adjusting the refund amount.

6.2.2Magento 2

6.2.2.1Resolving a Current Magento Bug (v. 2.0.0)

In the 2.x version of Magento there is a bug. Please make the following adjustments to the file /vendor/magento/module-sales/Model/Order/Payment.php :

1. Delete the lines in the picture bellow which begin with a - .
2. Add the lines which has been marked with a + .

Figure 6.1: Adjustments so you are able to enter a credit memo.

Here you can find the codes to be inserted in the form of a text:

+ )->addComment( __('The credit memo has been created automatically.') );

6.2.2.2Performing Credits

For registered transactions you can create credits and transmit them automatically to giropay / paydirekt . In order to do so open an invoice of an already registered order. By clicking on "Credit Memo" a dialog will open for the refunds. Now you can adjust the number of products which you would like to credit in the credit memo dialogue.

Here you can find each step again including screenshots:

Figure 6.1: 1. Opening the Invoice

Figure 6.1: 2. Click on Credit Memo - Important the invoice needs to be opened first.

Figure 6.1: 3. Choose which products you would like to credit and click on Refund Online.

Figure 6.1: Overview of all the credits made

6.3Useful Transaction Information on the Order

6.3.1Magento 1

In each order, processed via our module, you can find an overview of the most important information about the transaction as well as a transaction history.

Figure 6.1: Transaction Information.

6.3.2Magento 2

In each order, which was processed by our module, you will find an overview of the most important information on the transaction and transaction history.

Figure 6.1: Transaction Information.

6.4Tax Calculation Settings

6.4.1Magento 1

To ensure that the taxes are calculated correctly and transmitted correctly to a third party invoice provider inside Magento please make sure that you set the calculation settings in the menu under System > Configuration > Tax as showed in the screenshot below.

Figure 6.1: Recommended tax calculation settings for Magento.

Please also make sure that inside the settings of your promotion in the tab "Actions" the discount is not applied to the shipping amount as Magento is not correctly transmitting the tax rate there.

6.5OneStepCheckout

6.5.1Magento 1

The checkout of Magento can be modified and reduced to one step. The so called OnePageCheckout. Our modules support the most important OnePageCheckout extensions. If you are thinking of using a OneStepCheckout extension in combination with our giropay / paydirekt Magento, please make sure that you are using one of the following:

• OneStepCheckout by www.onestepcheckout.com
• OneStepCheckout by Ahead Works
• LightCheckout by GoMage
• Firecheckout by Templates Master

6.5.2Magento 2

6.6Setup a Cron Job to Activate the Timed Operations

6.6.1Magento 1

To activate the timed operations of the plugin (e.g. update service, deleting pending orders, etc.) make sure that you set up the Magento Cron engine. Especially the update function allows you to automatically retrieve additional information or changes of your order directly via the API of giropay / paydirekt. Please note it could be that in order to use the update feature it may be necessary that giropay / paydirekt activates additional options in your account.

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

Here we suggest you use a Cron Engine like for example EasyCron. This allows you to open the file (URL) with an external service.

6.6.2Magento 2

The module uses the standard cron engine of Magento 2. More information regarding the set up can be found here.

6.7Magento 1 API Manual

Via API, our module provides plenty of information on a transaction. The following section describes which calls are possible and what information is provided.

6.7.1General Information on Using the API

General information on using the Magento SOAP API can be found here: http://www.magentocommerce.com/api/soap/introduction.html

6.7.2API Calls

This overview shows the API Versions and which API Calls they support.

6.7.2.1API V1

• $client->call($session, 'paydirektcw_transaction.list'); //List of all transactions
• $client->call($session, ‘paydirektcw_transaction.info', {transactionsId}); // Single Transaction

6.7.2.2API V2

• $client->paydirektcwTransactionList($session); //List of all transactions
• $client->paydirektcwTransactionInfo($session, {transactionsId}); //Single Transaction

6.7.2.3XML-RPC

• $client->call('call', array($session, 'paydirektcw_transaction.list')); //List of all transactions
• $client->call('call', array($session, 'paydirektcw_transaction.info', {transactionsId})); //Single Transaction

6.7.2.4REST

• $this->callApi(‘paydirektcw/transactions'); //List of all transactions
• $this->callApi('paydirektcw/transactions/{transactionsId}'); //Single Transaction

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.1Module is not shown

If the module is not shown even though the files have been downloaded onto the server correctly, please check the following:

• The local.xml can be found in the /app/etc directory
• Make sure disable_local_modules is set to ‚false‘

8.2The Referrer URL appears in my Analytics Tool

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

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

9.1Magento 1

9.1.1Fees and discounts within Magento

To configure a giropay / paydirekt payment gateway based fee and discount, you will need the following 3rd-Party plugin.

• Fooman Surcharge

9.2Birthday and gender in Magento 1

For certain payment service providers it is necessary to check the birthday an the gender of a customer. Magento 1 does not check this by default. this check can be enabled under "Go to System > Configuration | Customers > Customer Configuration > Name and Address Options".

9.3Birthday and gender in Magento 2

For certain payment service providers it is necessary to check the birthday an the gender of a customer. Magento 2 does not check this by default. this check can be enabled under "Stores > Configuration | Customers > Customer Configuration > Name and Address Options".

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 giropay / paydirekt settings. The store log setting does not affect these log messages.

• 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 Magento log directory. (Default Path: {shopRootDirectory}/var/log)

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.

11.1.1Magento 1

define('MAGENTO_ROOT', getcwd());
$mageFilename = MAGENTO_ROOT . '/app/Mage.php';
require_once $mageFilename;
Mage::setIsDeveloperMode(true);   
ini_set('display_errors', 1);
umask(0);
Mage::app();

$dbtransaction = Mage::getModel('paydirektcw/transaction')->load($transactionId);
$transactionObject = $dbtransaction->getTransactionObject();

$dbtransaction = Mage::getModel('paydirektcw/transaction')->load($orderId,'transaction_external_id');
$transactionObject = $dbtransaction->getTransactionObject();

11.1.2Magento 2

use Magento\Framework\App\Bootstrap;
require __DIR__ . '/app/bootstrap.php';
$bootstrap = Bootstrap::create(BP, $_SERVER);
$obj = $bootstrap->getObjectManager();
$state = $obj->get('Magento\Framework\App\State');
$state->setAreaCode('frontend');

$factory = $obj->get('Customweb\PayDirektCw\Model\Authorization\TransactionFactory')->create();

$dbTransaction = $factory->load($transactionId, 'entity_id');
$transactionObject = $dbTransaction->getTransactionObject();

$dbTransaction = $factory->load($orderId, 'order_id');
$transactionObject = $dbTransaction->getTransactionObject();

$dbTransaction = $factory->load($paymentId, 'payment_id');
$transactionObject = $dbTransaction->getTransactionObject();