1Introduction

This manual describes how to install configure and use the payment module for OpenCart and PAYONE.

Before you get started, make sure to have all necessary data at hand.

• You received a user name and a password from PAYONE. Log in to the PAYONE Merchant Interface. ( https://pmi.pay1.de/)
• OpenCart payment module from sellxed.com/shop
• Login data for your server and shop

2PAYONE Channels

According to the functions of the module which you want to use, you have to request the different channels at PAYONE. With the numbers of channels come various costs on the part of the PAYONE. Here you'll find an overview of the different functions and their corresponding channels.

• Channel Frontend: Payment page
• Channel Client-API: Hidden, Alias Manager, Ajax, Moto
• Server-API: Refund, Capture, Cancel

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

2.1Installation Process

This document contains all information necessary to install the module. Make sure to follow the described steps strictly in order to ensure the safe use of the module in compliance with all security regulations.

1. Configuration of the PAYONE test administration surface. The test platform can be found under https://pmi.pay1.de/
2. Configuration of the main settings
3. Configuration of the payment methods
4. Conducting a test order by means of the Test Data enclosed at the end of this document

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

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.

3PAYONE - Backend Configuration

First, log on to the PAYONE Merchant Interface (https://pmi.pay1.de/)

3.1Payment Portal Setup

Under Configuration > Payment Portals you can set up the payment portal for your shop. Among other things you define the TransactionStatus URL. This is the URL that the parameters for further processing are sent to after payment has taken place.

3.1.1Shop Portal Administration: Tab General

General settings such as portal name, Shop URL and the sender e-mail can be defined in the tab 'General'. These settings can be defined independently.

Make sure that the Server API, Front-end and Client API are activated in the Channel settings as shown in the screenshot.

Figure 3.1: Tab 'General'

3.1.2Shop Portal Administration: Tab Extended

In this tab you define the TransactionStatus URL. The URL you need to enter can be found directly on the general information site of the module in your shop. More information can be found in the section Transaction-Feedback).The remaining fields can be left empty. They will be filled by the module.

Figure 3.1: Extended configuration of the payment portal

3.1.3Shop Portal Administration: API-Parameter

This tab contains all relevant information to enter in the Main Module .

Figure 3.1: API-Parameter Configuration.

3.2Authorization Methods

In the configuration of the payment method you have the possibility to switch between various authorization methods. These regard primarily the depiction of the credit card forms in the shop. You'll find further information about that in chapter authorization methods.

3.3Account Activation

Further information on the payment method configuration and the implementations of the settings can be found here. After the activation and configuration of the payment methods you can conduct a test by means of the Test Data provided in this manual. As soon as the tests As soon as the tests have been successful you can contact PAYONE to demand the activation of your account. You will be able to process payments immediately.

4Module Installation and Update in the OpenCart Shop

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

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

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

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

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

6OpenCart 3.0 Installation - Additions

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

6.1Configuration of the Main Module

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

By clicking Edit you can configure the main module. Enter all data in the corresponding fields. Each option is, furthermore, explained in short info texts in the shop.

6.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 PAYONE configuration. The URL to be entered can be found in your OpenCart Shop under: ___setupForm____ > Setup

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

6.4Direct 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.5Uncertain 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.5.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.6Optional: 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 PAYONE 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 PAYONE 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 PAYONE' 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 PAYONE are being blocked. In this case check the settings of your firewall and ask the Hoster to activate the IPs and User Agents of PAYONE.

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

8.1Useful Transaction Information on the Order

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

Figure 8.1: Transaction Information in OpenCart.

8.2Using Invoice Details of a Processor

In the following context you can view or embed the "payment details" of for example an "Open Invoice" transaction:

8.2.1OpenCart Order Confirmation (E-Mail)

The "payment information" will be visible in the default "order confirmation e-mail" of OpenCart.

8.2.2OpenCart Invoice (PDF)

This feature is not available by default in OpenCart that`s why it can not be supported by the payment gateway module.

8.2.3OpenCart-Backend (Transaction details)

You can view the payment and transaction details in OpenCart under Sales > PAYONE Transactions. If you can not find this menu point you have to clear the OpenCart modifications under Extensions > Modifications >.

Figure 8.1: Transaction details within OpenCart.

8.2.4OpenCart Success-Page

Due to technical limitations, it is currently not possible to display the "payment information" here.

8.3Usage of the Alias Managers / Token Solution

With the Alias Manager, your customers can securely save their credit cards with PAYONE 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

8.4Capturing / Cancelling of Orders

8.4.1Capturing Orders

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

8.4.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 PAYONE directly in order to clarify questions.

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

Figure 8.1: Capturing of Orders

8.4.2Cancel Orders

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

Figure 8.1: Capture or Cancel in OpenCart.

8.5Refunding 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 8.1: Refunds in OpenCart for PAYONE.

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

8.6Setup a Cron Job to Activate the Timed Operations

To activate the timed operations of the plugin (e.g. update service, deleting pending orders, etc.) make sure that you set up the OpenCart Cron engine. Especially the update function allows you to automatically retrive additional information or changes of your order directly via the API of PAYONE. Please note it could be that in order to use the update feature it may be necessary that PAYONE 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=payonecw/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.

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 PAYONE 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 OpenCart

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

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 PAYONE 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 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)

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('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')));

require_once DIR_SYSTEM.'library/cw/init.php';
require_once DIR_SYSTEM.'library/cw/PayoneCw/Util.php';
require_once DIR_SYSTEM.'library/cw/PayoneCw/Entity/Transaction.php';
PayoneCw_Util::setRegistry($registry);

$transactionById = PayoneCw_Entity_Transaction::loadById($transactionId);
$transactionObject = $transactionById->getTransactionObject();

$transactionsByOrderId = PayoneCw_Entity_Transaction::getTransactionsByOrderId($orderId);
foreach($transactionsByOrderId as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}