1Introduction

This manual describes the installation, configuration and usage of the payment module for PrestaShop 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
  • PrestaShop 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 PrestaShop 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 PrestaShop 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

You will find the settings for the module under Modules, in the group Checkout , PowerPay Integration. Install the module and open the configuration mask by clicking Configure. Enter the individual options such as described above in the configuration of the administration interface of PowerPay. You will find information on the individual options directly in the additional texts in the module

Do not forget to configure the main shop view first!

If you are using a multishop setup within PrestaShop, you will need to configure the payment plugin in the main shop view first. If you do not configure the settings of the plugin in the main shop view at all, the payment will not work properly. We strongly advise you to configure your main store first before moving on to the configuration of your subshops.

4.2Configuration of the Payment Method

After having successfully installed the main module, you can find the supported payment methods under Modules > Installed Modules. Install each payment method you wish to offer in your shop. In order to configure the module, click 'Configure'. You can save individual settings for each payment method and thereby optimally adapt the payment to your processes. The most central are explained in more detail in this manual.

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.

4.9.1Usage of the Integrated Multishop Functionality of PrestaShop

The payment module supports the multishop feature of PrestaShop. 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 PrestaShop 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 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.

6.1Capturing of Orders

Please note

The transaction management between your shop and PowerPay is not synchronized. If you capture payments with PowerPay, 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 the option 'Capturing' to 'deferred' in the payment method configuration.

Transactions can be captured in different ways. The different options are explained below.

6.1.11. Via Orders > PowerPay Transactions

You can view all transactions in the sellxed transaction table under Orders > PowerPay transactions"

Figure 6.1: 1. View Transactions via Orders > PowerPay transactions.

Open the order and then click on the small magnifying glass in den transaction information overview. By clicking Capture Button, you get into the following context.

Figure 6.1: Invoice capturing in PrestaShop

Enter the amount and quantity that you wish to capture from the customer's authorization. By clicking Capture a direct capturing of the order occurs with PowerPay.

6.1.22. Capture the transaction through the order and the PowerPay transaction tab

Open the order and then click on the small magnifying glass in the PowerPay transactions overview.

Figure 6.1: Open order and view the transaction tab.

A window will then drop down. Enter the amount of your choice that you wish to capture from the customer's authorization. By clicking Capture a direct capturing of the order occurs with PowerPay.

Figure 6.1: 2. Transaction details in the transaction tab of a specific order.

By clicking Capturing Button, you get into the following context.

Figure 6.1: Deferred/Manual capture of transactions within PrestaShop

Enter the amount or quantity choice that you wish to capture from the customer's authorization. By clicking Capture a direct capturing of the order occurs with PowerPay.

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.

Figure 6.1: Transaction information within PrestaShop.

6.3Place Orders in the Back-End of PrestaShop

With the PrestaShop payment module you can place orders and capture the payment directly in the shop; so called Mail Order / Telephone Order (MOTO).

  1. Go to the order overview and click on "Create New Order"
  2. A window will open up. Search for the customer for whom you wish to place an order or manually create a new customer
  3. Search for the product in question and add it to your cart
  4. Before clicking Create Order, select the payment method
  5. Depending on the authorization method that you have saved for the selected payment method, you will either be redirected to the Payment Page of PowerPay or the mask for the credit card will appear such as in the image below. Enter the customer's credit card information and click Debit the customer.
Figure 6.1: MoTo Transactions in PrestaShop

6.4Refunds

You can refund already captured transactions and automatically transmit them to PowerPay. In order to to so, open the order. You have two alternatives for refunding the money. Either you use the sellxed refund tool or the partial refund process of PrestaShop. Both processes are explained in this passage.

6.4.11. sellxed Transactiontable via Orders > PowerPay transactions

You can view all transactions in the sellxed transaction table under "Orders > PowerPay transactions"

Figure 6.1: 1. transaction table via rrders > PowerPay transactions.

Open the order and then click on the small magnifying glass in den transaction information overview. By clicking Refund Button, you get into the following context.

Figure 6.1: Refund of transactions within PrestaShop.

Just like for the capturing, you open the order and click on the magnifying glass next to the order of your choice. Enter any refund amount of your choice in the field provided for this purpose. By clicking refund the refund request will directly be sent to PowerPay and the specified amount will be credited on the customer's credit card.

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

6.4.22. Refund the transaction through the order and the PowerPay transaction tab

Open the order and then click on the small magnifying glass in the PowerPay transactions overview.

Figure 6.1: Open order and view the transaction tab.

By clicking Refund Button, you get into the following context.

Figure 6.1: 2. transaction details in the transaction tab of a specific order.

By clicking Refund Button, you get into the following context.

Figure 6.1: Refund of the transaction within PrestaShop.

Enter any refund amount of your choice in the field provided for this purpose. By clicking refund the refund request will directly be sent to PowerPay and the specified amount will be credited on the customer's credit card.

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

6.4.33. Refund with the PrestaShop internal/default functionality.

You can carry out refunds with the Partial Refund Process of PrestaShop based on the product quantity. After having opened the order, click on Partial Refund in the top right corner. The browser will scroll down and you can specify the amount of the partial refund. If you wish, you can also directly add the item(s) to the stock. In order to do so, click on the corresponding check-box. By clicking Partial Refund, a new window opens up.

Figure 6.1: Refund of transactions within PrestaShop.

In the following window, click 'Yes' in order to transmit the refund to PowerPay and the specified amount will be credited to the customer's credit card.

Figure 6.1: Confirm the transaction refund in PrestaShop.

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

6.5One Page Checkout

The checkout of PrestaShop can be modified and reduced to one step. The sellxed modules support the standard OnePageCheckout of PrestaShop. No guarantee can be made in regards to the compatibility with third party modules.

You can activate the standard checkout by going to Preferences, Orders. Choose the option 'one-page checkout' in the drop-down menu for Order-process type.

>

6.6Setting up Cron Job

> >

In order to activate the time-controlled functions of the plugin > (such as update service, deleting pending orders, etc.) set up a > time-controlled request in your hosting provider backend using the URL which you will now find > > via Modules > PowerPay in the tab > "Extended Information". Invoking it regularly will trigger the actions.

> >

> Here we suggest you use a Cron Engine like for example href="https://www.easycron.com?ref=39190" target="_blank">EasyCron. > 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.1Modul Performance

Depending on your server specs it could be that the module results to performance issues in your store. In this case we suggest to do the following:

  • Deactivate the PrestaShop Cache. We often saw already better results when the cache was disabled.
  • Deactivate the PrestaShop displayBackOfficeHeader hook. For this go to > Modules > Hooks > and disable the hook PowerPay Integration under the displayBackOfficeHeader Menu.

In case you want to undo the changes above you will need to re-install the base module again.

Figure 8.1: Disable the PrestaShop Hook.

8.2The 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.

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.1Fee's and discount's within PrestaShop

To configure a PowerPay payment gateways based fee and discount you will need the following 3rd-Party plugin.

9.2Birthday and gender in PrestaShop

For certain payment service providers it is necessary to check the birthday an the gender of a customer. PrestaShop does not check this by default. Information on how to enable those checks can be found here:

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

If you're using Prestashop Version 1.5, make sure you FTP access to the server before activating the logging, as you may need to fix the write permissions on the log file.
  • Off: Nothing is logged. (Default)
  • Error: Logs unexpected errors only.
  • Info: Logs extended information.
  • Debug: Logs information helpful for debugging.

10.2Log Location

In PrestaShop 1.5 the FileLogger is used. The log file is stored in the log folder of your installation. Please make sure the path exists and it is writable by the webserver. (Default Path: {shopRootDirectory}/log/)

In PrestaShop 1.6 and newer the default PrestashopLogger is used and are therefore stored in the database. The log message are visible in the PrestaShop backend under the menu item Advanced Parameters > Logs.

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.

Have Prestashop initialized in your script, this is required for the database connection.
require(dirname(__FILE__).'/config/config.inc.php');
Include the module main file and modules Transaction class.
require_once _PS_ROOT_DIR_.'/modules/powerpaycw/powerpaycw.php';
require_once _PS_ROOT_DIR_.'/modules/powerpaycw/lib/PowerpayCw/Entity/Transaction.php';
Now you can load the transaction and then extract the transactionObject.
Load the transaction by Id:
$transactionById = PowerpayCw_Entity_Transaction::loadById($transactionId);
$transactionObject = $transactionById->getTransactionObject();
Load transactions by Order ID:
$transactionsByOrderId = PowerpayCw_Entity_Transaction::getTransactionsByOrderId($orderId);
foreach($transactionsByOrderId as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}