This manual describes how to install, configure and use the payment module for Shopware and Innocard.

Before getting started with the Installation make sure to have all necessary data at hand:

  • Innocard Shop ID
  • Innocard Test and Live Certificate
  • Shopware Payment module from sellxed.com/shop
  • Login data for your server and shop

1.1Installation Process

This document contains all information necessary to install the module. When installing the module, strictly follow the instructions. This ensures the safe use of the module in compliance with all security regulations.

  1. Entering the Main Configuration into the main module
  2. Configuration of the payment methods
  3. Conducting a test order with the Test Data provided at the end of this document
  4. Creating the production certificate in the Innocard-backend.
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 Innocard might not get through to the shop.


2.1Main Configuration

For the module configuration, go to the setting page in the Main Module of your shop and enter the following data for the Live Tests in the corresponding fields.

2.1.1Settings > Shops > Your Shop (Innocard Backend)

All information necessary for the installation can be found in the Innocard Backend ( https://secure.innopay.ch/vads-merchant/) under Settings > Shops. Here you can select the shop you want to install.

Transfer the data into the Main Module:

  • Shop ID
  • Test certificate
Figure 2.1: Payzen Settings

2.1.2Production Certificate

As soon as the test payments were successful, set the Operation Mode to Live and request the activation of your account with Innocard. After the activation you can enter the Certification Key under Settings > Shops > in the main module.

2.1.3Payment Notifcation

For the Instant Payment Notification please enter the URL that is generated in the main module in the backend of Innocard. More information can be found under the section Transaction Feedback Enter the notification URL in the backend of Innocard under Settings > Notification Rules > 'IPN bei Erstellung einer Rate' into both TEST and LIVE fields and check 'Automatic Retry in case of failure'.

Figure 2.1: Entering the Notification URL

2.2Payment Method Configuration

All other setting options in the main module are not relevant for the product Checkout Page and can be ignored. The next step is the payment method configuration.


The credit card data for the testing is shown on the Payment Page. By clicking on it the card number is transferred to the mask.

3Module Installation and Update in the Shopware Shop


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

3.2.3Updated Plugin from the InnocardCw to the CwbInnocardCw Version.

We plan to release this plugin in the shopware store in the near future. To make this possible we hda to apply some changes to our code. Most important a prefix for our PHP classes is required and the plugin folder had to be renamed. To update to this new version simply overwriting the existing files is not possible. This sections describes the steps required to update the module in detail.

Do not do updates directly in the live environment

Please test the update procedure first in your development system. So you can ensure the update is working correctly.

Mutliple Plugins

If you are using multiple plugins from us. You need to update all of them to the new version.

  1. Activate the maintenance mode of the shop.
  2. Make a back up for your database and your files in your shop. Without this you will not be able to revert to the old version, if anything goes wrong.
  3. Upload the new plugin files.
  4. Deactivate the existing plugin. Do not deinstall the old plugin yet.
  5. Install and activate the new plugin.
  6. If you have custom css or template files for the plugin, adapt the changes to the new plugin.
  7. If you are using the Shopware API endpoint of this plugin, update the URL to new endpoint.
  8. Verify the main and method settings.
  9. Deinstall the old plugin.
  10. Delete the files of the old plugin. The following files/folders must be removed, if they exist:
    • engine/Shopware/Plugins/Local/Frontend/InnocardCw
    • engine/Library/Customweb
    • engine/Library/Crypt
    • engine/Library/File
    • engine/Library/Math
    • engine/Library/Mobile
    • engine/Library/Net
    • engine/Library/PhoneNumber
    • engine/Library/System
    • engine/Library/loader.php
    • engine/Library/openssl.cnf
  11. Make a test transaction to verify everything is workin correctly.
  12. Deactive the maintenance mode of the shop.

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

4.1Configuration of the Main Module

In order to install the main module search for Innocard under Settings > Plug-in Manager . Click on the + symbol in order to begin the installation process. Afterwards, click the "edit" symbol and configure the main module.

Enter the individual options which you partly may have already used for the configuration of the administration interface of Innocard. Should an option not be clear to you, you can click on the question mark and will find further information on the settings.

4.1.1Capture Delay

You have the option to set a Capture Delay with the configuration. The Capture Delay defines, how many days after the authorization the transaction should be captured. We recommend to leave the number at 0 (standard setting).

In case you want to 0 we strongly recommend setting up a Cron Job so you can stay informed about the transaction status at all times.

In any case, it is helpful to set up the Cron Job to be informed about the Capture Status of the transaction. Instructions on how to set up a Cron Job can be found in this manual under Cron Job.

4.2Defining the URL for the Transaction Feedback

To ensure correct payment processing in your shop, at least one Feedback URL has to be provided in the Innocard configuration. The URL to be entered can be found in your Shopware Shop under: Configuration > Innocard > Setup > Setup

4.3Configuration of the Payment Method

After having configured the main module, you will find all payment methods under Settings > Payment Methods. Activate each payment method you wish to offer in your shop. You can save individual settings for each payment method (and for each shop in case of a multi-shop set-up) and thereby optimally adapt the payment methods to your existing processes. The most central options are described in more detail further below.

Figure 4.1: Configuration of the Payment Method

4.4Assigning the Payment Method to the Shipping Costs

In order for the transactions and the shipping costs to be matched correctly to the payment methods you need to assign the payment methods to the shipping methods. Go to settings > shipping costs. Open all the shipping costs and add a payment method.

Figure 4.1: Assigning the Payment Method to the Shipping Method.
Attributing Payment Methods to the Shipping Method

Depending on the amount of delivered payment methods, it may be that certain payment methods can't be attributed to a specific shipping method as not all payment methods can be displayed. This is a known bug of Shopware. Merely the first 30 payment methods are displayed. Please delete all payment methods that you don't need and then all other payments will be displayed.

4.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 Innocard based on the shop ID.

4.6Order Prefix

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

4.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 Innocard 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 Innocard for further information or switch to another authorization method.

4.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 Innocard and the module

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

4.9Uncertain Status Status

You can specifically label orders for which for example no 3D-Secure verification nor any other security mechanism was carried out. This allows you to manually control the order before shipment.

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

4.11Defining the URL for the Transaction Feedback

To ensure correct payment processing in your shop, at least one Feedback URL has to be provided in the Innocard configuration. The URL to be entered can be found in your Shopware Shop under:Configuration > Innocard > Setup

4.12Multi-Shop Set-Up

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

Figure 4.1: Multi-shop set-up

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

4.12.1Usage of the Integrated Multishop Functionality of Shopware

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

5Settings / Configuration of Payment Methods

5.1General Information About the Payment Methods

All sellxed payment modules are delivered with 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 Innocard 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.

Important info regarding Order Status

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

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

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

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 over the most important features in the daily usage of the Innocard module.

6.1Capturing / Canceling of Orders

6.1.1Capturing Orders

Please note

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

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

Open the order you wish to capture and switch to the tab Transactions. Here you will find the tab Captures. Enter the amount you wish to debit from the customer's card. By clicking Capture, a direct capturing of the order occurs with Innocard.


By clicking the button Cancel, you delete the initial authorization on the customer's card. The pre-authorized amount is released from the customer's card.

Figure 6.1: Capturing/Cancellation of orders in Shopware

6.2Useful Transaction Information on the Order

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

In order to get to the transaction information, open the order and switch to the tab Transactions. Here you will find all authorization attempts and the related information.

Figure 6.1: Transaction Information in Shopware.


You can refund already captured transactions and automatically transmit them to Innocard. In order to to so, open the order. Switch to the tab Transactions. A new window will open up in which you must then switch to the tab Refunds in order to refund orders.

To refund a line item you need to enter the quantity you wish to refund. By clicking Refund, the refund is automatically transmitted to Innocard. It will than be refunded via the payment method the customer chose for the transaction.

Figure 6.1: Refunding Orders in Shopware.

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

6.4Usage Abo Commerce / Recurring Payments

Abo-Commerce increases long-term customer loyalty. Customers can choose as many products as they wish and have them home to them in cycles of their choice. The advantage for customers: products that are required regularly are automatically delivered to their home.

Shopware offers you the possibility of offering Abo Commerce in your shop. In order to do so, a special module has been developed by Shopware (Abo Commerce Module). All sellxed payment modules are compatible with the Abo Commerce module of ____shopSytemName____. In case of questions concerning the Abo Commerce Module, please contact Shopware directly.

Abo Commerce requires the additional option with Innocard

The usage of Abo Commerce requires the activation of additional options with Innocard.

6.5Usage of the Alias Managers / Token Solution

With the Alias Manager, your customers can securely save their credit cards with Innocard 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 Usage in Shopware
Please note!

The usage of the Alias Managers requires the activation of the correct option with Innocard. To do so, please contact the support directly.

7Getting the Credit Card Data via Shopware REST API

When connecting ERP systems to Shopware it may be that further information is required via Shopware API. The sellxed modules provide you with a lot of payment information also via Shopware REST API.

Basic Information about the usage of the REST API of Shopware can be found in the Shopware Developers Guide.

The service can be called up under https://www.shop-url.com/api/CwbinnocardcwTransactions. The call of the above URL leads to the listing of all transactions. By adding the Transaction ID you can filter by the corresponding Transaction ID. The Transaction ID can be found in the order overview (Customer > Payments > Innocard )

Additionally, you can also access the transaction via the Payment ID (transmitted through Innocard). To do so, the parameter 'usePaymentId=1' has to be added as a parameter to the URL.

8Set-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 Shopware Cron engine. Especially the update function allows you to automatically retrieve additional information or changes of your order directly via the API of Innocard. For payment methods which use a delayed authorisation process this is mandatory. Please note it could be that in order to use the update feature it may be necessary that Innocard activates additional options in your account.

The module uses the standard cron engine of Shopware. More information regarding the set up can be found here: https://community.shopware.com/Cronjobs_detail_1102.html.


Before switching from test to live mode it is important that you test the module extensively. You can find all relevant test credit card data under: http://www.sellxed.com/de/testen.


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

9.1Test Data

In the following section you can find the test data for the various payment methods:
Credit Card
Card number
Expiry Date
Card number
Expiry Date
Card number
Expiry Date
Card number
Expiry Date
Card number
Expiry Date
Card number
Expiry Date
Card number
Expiry Date
American Express
Card number
Expiry Date

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 Innocard 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 a easier way.

11.1Birthday and gender in Shopware

For certain payment service providers it is necessary to check the birthday an the gender of a customer. Shopware does not check this by default. To enable these checks go to "Configuration > Basic Settings > Frontend > Login / Registration" and check the following parameters:

  • Show Birthday Field
  • Birthday is required
  • Show "I am" select field

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 Innocard 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 Shopware log directory. Please make sure the path exists and it is writable by the webserver. (Default Path: {shopRootDirectory}/logs or {shopRootDirectory}/var/log)

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.

Have Shopware initialized in your script, this is required for the database connection.
require __DIR__ . '/autoload.php';
use Shopware\Kernel;
$environment = 'production';
$kernel = new Kernel($environment, false);
Register the module module classes.
$pluginPath = 'engine/Shopware/Plugins/Local/Frontend/CwbInnocardCw';
Shopware()->Loader()->registerNamespace('Customweb', 'Customweb/');
Shopware()->Loader()->registerNamespace('CwbInnocardCw_Helpers', $pluginPath . '/Helpers/');
Shopware()->Loader()->registerNamespace('CwbInnocardCw_Entities', $pluginPath . '/Entities/');
Shopware()->Loader()->registerNamespace('CwbInnocardCw_Components', $pluginPath . '/Components/');
Shopware()->Loader()->registerNamespace('Shopware\Components\Api', $pluginPath . '/Components/Api/');

require_once $pluginPath . '/Library/loader.php';
Customweb_Core_Util_Class::registerClassLoader(function ($className){
	return Shopware()->Loader()->loadClass($className);
To load old transactions register a legacy class loader.
		if(strpos($className, 'InnocardCw') === 0){
			$fileName = substr($className, strrpos($className, '_')+1).".php";
				require_once 'engine/Shopware/Plugins/Local/Frontend/CwbInnocardCw/Legacy/'.$fileName;
				return true;
		return false;
Now you can load the transaction and then extract the transactionObject.
Load the transaction by Id:
$transactionById =  CwbInnocardCw_Helpers_Util::loadTransaction($transactionId);
$transactionObject = $transactionById->getTransactionObject();