1Introduction

This manual describes the installation, configuration and usage of the payment module for Drupal and PowerPay.

Before starting the installation, make sure to have all necessary data at hand:

  • PowerPay Merchant ID
  • PowerPay Branch ID
  • PowerPay Terminal ID
  • PowerPay Authentication User and Passwort
  • Drupal payment module from sellxed.com/shop
  • Login data for your server and shop

1.1Installation Process

This document contains all the information you need to install the module. When activating the module, you should follow the described steps strictly as they guarantee the safe use of the module in compliance with all security regulations.

  1. Enter the General Configuration into the main module
  2. Configurate the payment methods
  3. Conduct a test order
  4. Activate your account
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 PowerPay might not get through to the shop.

2Configuration

2.1General Configuration

In order to configurate the module, go to the setting page in the main module of your shop and enter the data into the respective fields.

2.2Payment Method Configuration

The next step is the payment method configuration. As a new payment method, you should find PowerPay Open Invoice among the available payment methods of your webshop. Activate this payment methods.

Define whether you want to process invoices as monthly invoices or as order invoices in the field invoice type. The option you select has to be enabled in your customer account as well. If you decide to go with the option order invoices, you will receive the ESR data from PowerPay in the backend of your shop. The invoice will not be sent out by the plugin so you will need the data to create the invoices. If you prefer to carry out the authorization before the payment methods are dispayed, a credit check can be conducted in advance. The payment method will only be displayed if the PowerPay credit check yielded a positive result. In order to activate this method, set the Validation to before payment method display.

2.3Testing

You can conduct a test with any address data. After successful testing, set the mode in the main module to Live.

3Module Installation and Update in the Drupal 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 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

4Module Configuration in the Drupal 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.1Basic Module Configuration

In order to install the basic module, search for PowerPay under Site Settings > Modules . Activate the module by checking the box and set click on save configuration.

Once the installation has been completed, go to Store Settings > PowerPay to configure the basic settings. Enter the necessary parameters that are explained in the help texts.

4.2Payment Method Configuration

Once the basic module configuration is completed, you can view the included payment methods under Store Settings > Payment Methods . Activate the payment methods that you want to support in your shop. Individual adjustments can be made for each method to ensure maximum compatibility to your processes. Open the configuration by clicking edit. Then, click on the link shown under the menu item Action and the payment method configuration will open.

Figure 4.1: Payment Method Configuration.

4.3Shop 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 PowerPay based on the shop ID.

4.4Order Prefix

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

4.5Selecting 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 PowerPay 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 PowerPay for further information or switch to another authorization method.

4.6Direct 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 PowerPay and the module

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

4.7Uncertain Status Status

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

4.8Optional: 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 PowerPay during the authorisation process. The payment method is displayed in any case

4.9Multi-Shop Set-Up

The payment module is designed for the usage of one PowerPay 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
Licensing

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

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

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

####conditional(isFeatureCapturingActive or isFeatureCancellationActive)####

6.1Capturing / Cancelling Orders

6.1.1Capturing Orders

Please note:

The transaction management between PowerPay and Drupal is not synchronized. If you capture payments through PowerPay the order status in the shop is not adjusted and no second capture in the shop is possible.

In order to capture orders, make sure to set the Capture to deferred in the Payment Method configuration.

Open the order you want to capture and switch to the tab Payments. By clicking 'view' additional order information is displayed. To capture the order, click on the button Capture . Enter the amount you want to charge the customer. When you click Capture, the order is directly captured by PowerPay.

Figure 6.1: Capturing / Cancelling orders with PowerPay
####conditional####

6.2Useful Transaction Information

When opening any order processed by a sellxed module, an overview of important information can be accessed, as well as a transaction history which shows all process steps of the order.

To view the transaction information, open the order and change to the tab Payments where you will find all information on the payment.

Figure 6.1: Transaction Information in Drupal.

6.3Refunds

Refunds for already charged transactions can be created directly in the shop and are transmitted to PowerPay automatically. To create a refund, open the order, switch to the tab Payment and click on 'view'. A new window will open. Click on Refund to refund an order.

By means of the input field, you can define the amount you want to refund. By clicking Refund, the request is transmitted to PowerPay the amount is added to the customer's credit balance.

Figure 6.1: Refunds with PowerPay.

Please keep in mind that the maximum for the refund is the originally charged amount.

6.4Cron Job Setup

Cron Jobs are necessary for the time-controlled plug-in functions (e.g. Update Service, deleting pending orders, etc.) and have to be set up in Drupal in order to use these options. Especially the Update function is useful since it allows you to fetch transaction changes by PowerPay via the API. Please note that additional options might have to be enabled.

This module uses the standard Drupal Cron. Information on the setup can be found at https://www.drupal.org/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.

7Testing

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.

Testing

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

7.1Test Data

In the following section you can find the test data for the various payment methods:
Open Invoice
First Name
Good
Last Name
Customer
Notice
Other fields can be filled at your discretion.
Accepted
Reason
Unknown customer
First Name
Unknown
Last Name
Customer
Gender:
Male
Street
via castello 4
Postcode
6500
City
Bellinzona
Country
Switzerland
Denied
Reason
Other
First Name
Bad
Last Name
Customer
Gender:
Male
Street
via paradiso 5
Postcode
6600
City
Locarno
Country
Switzerland
Denied

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.1The Referrer URL appears in my Analytics Tool

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

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

You need to have at least one module active, which stores the Drupal 'watchdog' messages. We recommend you activate the "Database logging" module, which stores this messages into the database. This module is available per default.

9.1Log Levels

You can configure the log level in the PowerPay settings. The logs are stored according to this setting and are not affected by the shopwide log level settings.

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

9.2Log Location

The log messages are visible, if the "Database logging" module is active, in the Drupal backend under the menu item Admin > Reports > Recent log messages.

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

10.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 Drupal initialized in your script, this is required for the database connection.
define('DRUPAL_ROOT', getcwd());
require_once DRUPAL_ROOT . '/includes/bootstrap.inc';
drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
Include the modules Util class.
module_load_include('php', 'commerce_powerpaycw', 'includes/classes/PowerpayCw/Util');
Now you can load the transaction and then extract the transactionObject.
Load the transaction by Id:
$transactionById = PowerpayCw_Util::loadTransactionById($transactionId);
$transactionObject = $transactionById->getTransactionObject();
Load the transaction by the external Id:
$transactionByExternal = PowerpayCw_Util::loadTransactionByExternalId($externalId);
$transactionObject = $transactionByExternal->getTransactionObject();
Load transactions by order Id:
$transactionsByOrder = PowerpayCw_Util::getTransactionsByOrderId($orderId);
foreach($transactionsByOrder as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}