1Introduction
This manual describes the installation, configuration and usage of the payment module for e-Commerce 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
- e-Commerce payment module from sellxed.com/shop
- Login data for your server and shop
Note that you must use at least PHP version 5.6 for our plugins. PHP 8 or higher is currently not supported.
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.
- Enter the General Configuration into the main module
- Configurate the payment methods
- Conduct a test order
- Activate your account
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 information 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
In order to test the module, any kind of directory protection or IP blocking on your server must be deactivated. This is crucial as 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.
2.2.1Configuration restrictions with subshops
The plugin only supports one Merchant ID in your shop system, even if you use subshops (for example in Shopware).
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 and QR-bill 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 e-Commerce Shop
3.1Installation
At this time you should already be in possession of the module. Should this not be the case, you can download the necessary files in your customer account in the sellxed shop (Menu "My Downloads Downloads"). In order to install the module in your shop, please carry out the following steps:
- Download the plugin. The download can be found in your sellxed.com account under "My Downloads".
- Unzip the archive you have just downloaded.
- In the unzipped folder navigate to the folder "files"
- 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.
- 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.
- 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:
- Always do a backup for your database and your files in your shop
- Use always a test system to test the update process.
- 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.
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. 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.
4Module Configuration in the e-Commerce 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.
Please create a backup 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
Activate the plugin by selecting the module E-commerce POWERPAY in the Plugin menu.
The settings for the basic module can be found at POWERPAY > POWERPAY . Fill out the fields, you should have already entered the necessary data in the POWERPAY backend or you received it as part of your correspondence with POWERPAY. Each option is explained in more detail in a short info text in the shop.
4.2Payment Method Configuration
After the basic module has been configured successfully, you can proceed to the payment settings. The payment methods you want to accept in your shop can be adjusted at Settings > Store > Payments . Every payment method is listed individually. Activate the payment methods you would like to provide in your shop by ticking the corresponding boxes on the right side. Individual changes can be made for each payment method to adjust it to your processes.
4.3Direct Capturing of Transactions
The option "Capture" allows you to specify if you wish to debit payments directly or if you first wish to authorise them and then debit the payment at a later point.
Depending on your acquiring contract, a reservation is only guaranteed for a specific period of time. Should you fail to debit the payment within that period, the authorisation may therefore no longer be guaranteed. Further information on this process can be found below.
It may be that settings saved in the payment modules overwrite settings saved in POWERPAY.
4.4Uncertain Status
You can specifically label orders for which the money is not guaranteed to be received. This allows you to manually control the order before shipment.
4.4.1Setting the order state
For each payment method you may select in which state the order should be set to depending on the booking state. This is the initial state of the order.
4.5Optional: Validation
Note: It can be that this option is not visible in your module. In this case just ignore this section.
With the option 'Validation' you can define the moment when the payment method should be made visible to the customer during the checkout process. This setting is relevant for modules where the usage depends on the customer's compliance with specific preconditions. For example, if a solvency check has to be carried out or if the payment method is only available in certain countries. In order for the credit check or address validation to also work with European characters, the charset of the "Blowfish mode" must be set to "UTF-8" for certain PSP settings.
You have the choice between these options:
- Validation before the selection of the payment method: A validation verification is carried out before the customer selects the payment method. If the customer does not fulfill the requirements, the payment method is not displayed
- Validation after selection of the payment method: The verification of the compliance occurs after the selection of the payment method and before the confirmation of the order
- During the authorisation: The validation verification is carried out by POWERPAY during the authorisation process. The payment method is displayed in any case
5Settings / Configuration of Payment Methods
5.1General Information About the Payment Methods
The plugin contains the most common payment methods. In case a desired payment method is not included per default, please contact us directly.
In order to be able to use a payment method, it must be activated in your account with 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.
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 of the most important features in the daily usage of the POWERPAY module.
6.1Useful Information on Transactions
For each order processed with our module you can access an overview of the most important transaction information. Among other things, this allows you to identify each corresponding order to each transaction displayed in the backend.
You can find the orders at Dashboard > Store Sales.
6.2Capture / Cancel Orders
6.2.1Capturing and Cancelling Orders
In order to capture orders, open the order first (Dashboard > Store Sales) and then open the transaction information. Enter the amount you want to capture into the input field. By clicking on Capture the card is charged directly.
An order can be cancelled by clicking "Cancel Transaction" and the transaction as well as the reserved amount is released on the customer's card immediately.
The transaction management between POWERPAY and your shop is not synchronised. When capturing payments in the POWERPAY, the status is not adjusted in the shop and a second capture is not possible.
Please inquire, whether multiple captures are supported within your POWERPAY contract. Otherwise, partially captured transactions could be blocked from future captures.
6.3Order Refunds
In order to refund an order, open the transaction information (see above).
You can refund individual items or an arbitrary amount by adjusting the total amount or the number of items.
Our module restricts the refund amount to 100% of the originally authorised amount.
6.4Transaction History
Every action within the transaction management is processed through the module. Information on each transaction can be viewed in the corresponding order.
6.5Cron Job Setup
In order to activate the time-controlled plugin functions (e.g. update service, deleting pending orders etc.) you have to set up cron jobs in e-Commerce. The update function is especially relevant - it allows you to fetch subsequent transaction changes at POWERPAY via the API. Please keep in mind that additional options might have to be activated.
The module uses the default e-Commerce cron. Information on the setup can be found here.
7Testing
Before switching from test to live mode it is important that you test the module extensively.
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:First Name Good Last Name Customer Country Switzerland Notice Other fields can be filled at your discretion. | Accepted CH |
Reason Unknown customer First Name Unknown Last Name Customer Gender Male Street via castello 4 Postcode 6500 City Bellinzona Country Switzerland | Denied CH |
Reason Other First Name Bad Last Name Customer Gender Male Street via paradiso 5 Postcode 6600 City Locarno Country Switzerland | Denied CH |
First Name Good Last Name Customer Country Germany Notice Other fields can be filled at your discretion. | Accepted DE |
Reason Unknown customer First Name Unknown Last Name Customer Gender Male Street Pirker Weg 5 Postcode 95030 City Hof Country Germany | Denied DE |
Reason Other First Name Bad Last Name Customer Gender Male Street Pirker Weg 5 Postcode 95030 City Hof Country Germany | Denied DE |
First Name Good Last Name Customer Country Austria Notice Other fields can be filled at your discretion. | Accepted AT |
Reason Unknown customer First Name Unknown Last Name Customer Gender Male Street Rennweg 97 Postcode 1030 City Wien Country Austria | Denied AT |
Reason Other First Name Bad Last Name Customer Gender Male Street Rennweg 97 Postcode 1030 City Wien Country Austria | Denied AT |
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.
9.1Log Levels
You can configure the log level in the POWERPAY settings.
- Error: Logs unexpected errors only. (Default)
- Info: Logs extended information.
- Debug: Logs information helpful for debugging.
9.2Log Location
The log file is stored in the logs folder of this plugin wp-content/plugins/plugins/ecommerce_powerpaycw/logs. Please make sure the path exists and it is writable by the webserver.
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.
require_once( dirname(__FILE__) . '/wp-load.php' );
require_once ABSPATH.'wp-content/plugins/ecommerce_powerpaycw/classes/PowerpayCw/Util.php';
$transactionById = PowerpayCw_Util::getTransactionById($transactionId); $transactionObject = $transactionById->getTransactionObject();
$transactionByExternal = PowerpayCw_Util::getTransactionByExternalId($externalId); $transactionObject = $transactionByExternal->getTransactionObject();
$transactionsByOrder = PowerpayCw_Util::getTransactionsByOrderId($orderId); foreach($transactionsByOrder as $transaction){ $transactionObject = $transaction->getTransactionObject(); //Do something with each object }