1Introduction

This manual explains the installation, configuration and usage of the payment module for JigoShop and Payrexx.

Before beginning with the installation, please make sure that you are in possession of all necessary data:

First of all you need to create an account at Payrexx. Enter your email address and choose a password. Additionally you will need to set an 'Instance'. The Instance corresponds to your account name.

1.1Installation Process

In this document you will find all the relevant information for the installation of the module. It is important that you follow the check-list rigidly. Only by doing so, a secure usage in correspondence with all security regulations can be guaranteed.

  1. Entering the API Secret, Template ID and Instance
  2. Configuration of the Main Module
  3. Configuration of the Accepted Payment Methods incl. Authorization Methods
  4. Conducting a Test Order
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 Payrexx might not get through to the shop.

1.2Configuration of the Main Module

In order to launch the main module the first thing you will need to do is to enter your credentials, which consist of an API Secret, a Template ID and an Instance. Where these credentials can be found is explained below.

1.2.1Entering the API Secret

The API Secret can be found in the backend of Payrexx via API & Webhook > API Secret. Enter the API Secret in the backend of JigoShop in the Configurations of the Main Module.

1.2.2Entering the Webhook-URL

For the Webhook please enter the URL that is generated in the main module. Enter the Webhook-URL in the backend of Payrexx in the category API & Webhook' > 'Webhook. More information can be found under the section Transaction Feedback

1.2.3Entering the Template ID

Via Home > Settings -> Look & Feel you are able to create a profil. When you view the "Preview" of the profil you can see a Template ID (tid) embedded in the URL. It is the part that comes after tid=___ (e.g. www.example.payrexx.com/tid=41c053c4 -> your Template ID is 41c053c4). Enter the ID in the Configurations of the Main Module via Template ID. This functions allows you to decide which templates will be visible.

1.2.4Entering the Instance

Last but not least you need to enter the Instance. You defined your Instance while creating your Payrexx account. Ordinarily the instance corresponds to the domain of your Payrexx payment page (e.g. http://sellxed.payrexx.com the name of your Instance would be sellxed). Also enter the Instance in the backend of JigoShop in the main configurations via Instance.

1.2.5Payment Service Providers

Via Payment Service Providers you can choose which payment processors are offered to you customers during the redirection to the Payrexx Payment Page.

1.3Configuration of the Payment Methods

Further information regarding the payment methods and implementations of the settings can be found here.

1.4Activating the Account

After the activation and configuration of the payment methods you can conduct a test. The test data can be obtained directly from Payrexx or your PSP. As soon as the tests have been successful you can switch the operating mode in the main module to Live.

In order to process payments you will also need to make sure that your Payrexx account as well as the configurations are active and in live mode. If you have any questions regarding the activation of you account please contact Payrexx.

2Module Installation and Update in the JigoShop Shop

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

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

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

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

3Module Configuration in the JigoShop 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.

3.1Configuration of the Main Module

You can activate the plug-in by clicking "activate" under the module WooCommerce Payrexx in the menu Plugins.

After the Installation of the plugin a new menu on the dashboard will appear called Payrexx . Enter all data in the corresponding fields. The required data has either already been saved in the back-end of Payrexx has been sent to you by Payrexx. Each option is, furthermore, explained in short info texts in the shop.

3.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 Payrexx configuration. The URL to be entered can be found in your JigoShop Shop under: Payrexx > Setup > Setup

3.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 WooCommerce > Settings > Checkout (In earlier version it was WooCommerce > Settings > Payment Gateways). 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 Enable the payment method is activated in your shop. For more detailed information on the settings, please refer to information provided directly within the module configuration.

3.4Shop 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 Payrexx based on the shop ID.

3.5Order Prefix

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

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

3.7Direct 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 Payrexx and the module

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

3.8Uncertain 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.

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

3.10Multi-Shop Set-Up

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

Figure 3.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.

4Settings / Configuration of Payment Methods

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

4.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 Payrexx or any similar pending status which is implemented by the module.

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

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

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

5The Module in Action

Below you will find an overview over the most important features in the daily usage of the Payrexx module.

5.1Useful Transaction Information on the Order

You can find an overview over all the most important information of a transaction in all orders that have been processed with the sellxed module. Among others, this information allows for the definite attribution of the orders to their corresponding transaction, seen in the back-end of Payrexx.

Figure 5.1: Transaction Information in WooCommerce.

5.2Transaction Process

Each action affiliated with transaction management is logged by the module.

Figure 5.1: Transactions in the Overview of the Transaction Process

5.3Set-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 JigoShop Cron engine. Especially the update function allows you to automatically retrive additional information or changes of your order directly via the API of Payrexx. Please note it could be that in order to use the update feature it may be necessary that Payrexx activates additional options in your account.

The module uses the standard cron engine of JigoShop. More infromation regarding the set up can be found here.

6Testing

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.

6.1Test Data

In the following section you can find the test data for the various payment methods:

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

7.1Page Not Found Error prior to the redirection to Payment Page

If you are using WPML it can occur that the Pages for the display of the payment methods or for the redirection to Payrexx end in a Page Not Found Error.

In this case you have to duplicate our Pages in the corresponding languages. In order to do so please follow these steps:

  1. Go to the main menu and select Pages > All Pages. There you should find a Page called Payrexx Checkout.
  2. Open the configurations.
  3. On the right hand side under languages you can now duplicate the content of this page for all of your installed languages. When you have successfully saved the changes this page will be active for all of your languages and the Error should have disappeared.

7.2The Referrer URL appears in my Analytics Tool

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

8Compatibility with Third-Party Plugins

8.1Multilingual JigoShop sites

To run multilingual JigoShop sites you will need the following 3rd-Party plugin.

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 Payrexx 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 wp-content/uploads/jigoshop-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.

Have Wordpress initialized in your script, this is required for the database connection.
require_once( dirname(__FILE__) . '/wp-load.php' );
Include the modules Util class.
require_once ABSPATH.'wp-content/plugins/jigoshop_payrexxcw/classes/PayrexxCw/Util.php';
Now you can load the transaction and then extract the transactionObject.
Load the transaction by Id:
$transactionById = PayrexxCw_Util::getTransactionById($transactionId);
$transactionObject = $transactionById->getTransactionObject();
Load the transaction by the external Id:
$transactionByExternal = PayrexxCw_Util::getTransactionByTransactionNumber($externalId);
$transactionObject = $transactionByExternal->getTransactionObject();
Load transactions by Post ID, this is the internal JigoShop order id:
$transactionsByPostId = PayrexxCw_Util::getTransactionsByPostId($orderId);
foreach($transactionsByPostId as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}