1Introduction

This manual explains the installation, configuration and usage of the payment module for Gambio 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 Settings > API > API Secret. Enter the API Secret in the backend of Gambio in the Configurations of the Main Module.

1.2.2Entering 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.3Entering 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 Gambio in the main configurations via Instance.

1.2.4Payment 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 Gambio 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 Gambio 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 will find the settings for the module under "Modules > Module-Center > Payrexx Base Module" . Install the module and click on "Open Method Configuration". A new window should open up. Enter the individual options such as described above in the configuration of the administration interface of Payrexx. Should one of the options not be clear to you, you can find further information by moving the cursor to the question mark. The most central settings are explained in more detail in this manual.

3.1.1Create Pending Orders

You have the possibility of creating pending orders. In this case a temporary order will be created with the status "pending payment". This allows you to reserve the item in your shop and to transmit the identical order number as in the shop to Payrexx. In the case when a customer cancels his or her purchase, the order remains in your shop - except if you activate the option "Remove cancelled orders". This makes sure that cancelled orders are deleted regularly. If you do not wish to create pending orders, simply keep the default setting of xt:Commerce. However, this also means that the reference number (payment ID) with Payrexx doesn't correspond to the order number in the shop. You are, however, free to use both options.

3.1.2Database Encoding

If you haven't selected UTF-8 as a default for your database, this might lead to encoding problems with parameters with special characters. In this case you must select the option that data is UTF-8 encoded before being sent to Payrexx.

3.2Shop 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.3Order 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.4Selecting 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.5Direct 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.6Uncertain 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.

3.7Optional: 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.8Multi-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.

4.2.3Code Adjustments for the MasterPass Integration (Gambio GX 1.x)

If you use GX 2.x, the following code adjustments are not relevant for you.

In order for the button "Pay with MasterPass" to appear in the shopping cart when using external checkout with address transmission, the following adjustments in the code have to be made. If you prefer to simply use MasterPass as a regular payment method without address transmission, no changes are necessary.

The files containing the necessary code adjustments can be found in the zip files in /changes/*.txt. Please paste the codes contained in these files into the location described below.

4.2.3.1Adjusting shopping_cart.php

Please copy the code snippet from the file /changes/shopping_cart.php.txt in front of the following code:

$smarty->assign('language', $_SESSION['language']); (ca. line 140)

4.2.3.2Adjusting templates/[current-active-template]/module/shopping_cart.html

Please copy the code found in /changes/shopping_cart.html.txt in front of the tag-{/if}:

4.2.4Further information

MasterPass with External Checkout cannot be used in combination with vouchers. If the customer wants to redeem a voucher, she has to go through standard checkout.

5The Module in Action

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

Figure 5.1: Transaction Information

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

5.2Set-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.), please activate in a regular request to the file payrexxcw_cron.php. The regular call triggers the appropriate actions.

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.

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

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

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

8.1.2Log Location

The log messages are visible in the Gambio backend under "Modules > Module-Center > Payrexx Base Module > Log Messages".

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

9.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 Gambio initialized in your script, this is required for the database connection.
include ('includes/application_top.php');
Include the module main file and module classes.
require_once DIR_FS_DOCUMENT_ROOT.'admin/includes/PayrexxCw/init.php';
require_once DIR_FS_DOCUMENT_ROOT.'admin/includes/PayrexxCw/classes/PayrexxCw/Entity/Util.php';
Now you can load the transaction and then extract the transactionObject.
Load the transaction by Id:
$transactionById = PayrexxCw_Entity_Util::findTransactionByTransactionId($transactionId);
$transactionObject = $transactionById->getTransactionObject();
Load the transaction by external Id:
$transactionById = PayrexxCw_Entity_Util::findTransactionEntityByTransactionExternalId($externalId);
$transactionObject = $transactionById->getTransactionObject();
Load transactions by Order ID:
$transactionsByOrderId = PayrexxCw_Entity_Util::findTransactionsEntityByOrderId($orderId);
foreach($transactionsByOrderId as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}