Skip to main content

Payone

With the Payone plugin, you integrate the Payone payment methods in your online shop and make them available to your customers. To do so, download the Payone plugin from the plentyMarketplace . Setup of the payment method is done with an assistant. You also have to carry out a few basic settings in your plentymarkets system so that the payment methods are activated in your system.
The explanations in this section apply after adding the plugin. You can find more information on adding and installing plugins in the Plugins section of the manual.

Requirement

The Payone plugin has been developed for use with plentyShop (Ceres) and only works with its structure or other template plugins. The plugins Ceres and IO have to be activated so that the Payone plugin can be used.

1. Requirement: Opening a Payone account

In order to use Payone, you need a Payone account. You get information as well as login details when you open the account. Without these, the plugin cannot be set up and is not usable. If your don’t have a Payone account yet, use this registration form  or contact:
PSG Projektmanagement GmbH
Meergässle 4
89180 Berghülen
Telephone: 00497344-9592588
Email: plenty@psg-projektmanagement.de
Internet: http://www.psg-projektmanagement.de

Upon receipt of your access data, log into the PAYONE merchant interface and carry out the following settings.

Carrying out settings in the Payone merchant interface:

  1. Open the Configuration » Payment portals menu.

  2. Open the Extended Tab of the payment portal of your online shop.

  3. In the field TransactionStatusURL, enter a URL following the pattern DOMAIN/payment/payone/status. Replace DOMAIN with the URL of your online shop.

  4. For the procedure Method hash calculation, select the option md5 or sha2-384 (during migration).

  5. Save () the settings.

2. Completing the assistant

After you have installed the plugin the corresponding assistant is available. Proceed as follows to complete the assistant and thus set up the payment method.

Setting up a payment method:

  1. Go to Setup » Assistants » Plugins » [select Plugin set].

  2. Select the assistant Payone.

  3. Complete the assistant.

The payment method Payone is available in your online shop.

Input fields in the account area of the assistant
Table 1. Account setup
Setting Explanation

Merchant ID

Enter your Merchant ID. You can get this in the Payone Merchant Interface after opening the Payone account. Go to the menu Configuration » payment method in the Merchant Interface.

Portal ID

Enter your Portal ID. You can get this in the Payone Merchant Interface after opening the Payone account. Go to the menu Configuration » payment method in the Merchant Interface.

Account ID

Enter your Account ID. You can get this in the Payone Merchant Interface after opening the Payone account. Go to the menu Configuration » payment method in the Merchant Interface.

Key

Enter the key. You can get this in the Payone Merchant Interface after opening the Payone account. Go to the menu Configuration » payment method in the Merchant Interface.

Mode

Select one of the modes Testing or Productive.

Authorisation method

Select the method of authorisation.
Preauthorisation: Select this option if payment collection should only be prepared for the customer. The definite collection of payment has to be effected by an event procedure that should be triggered by booking outgoing items.
Authorisation: Select this option if the payment should be collected from the customer immediately. Incoming payment is then booked directly after the customer has completed the checkout process in the online shop.

User ID for notes

Enter the ID of the user who should be the owner of the order notes.

Only when using a payment method for several clients: Complete assistant several times

Depending on the configuration of your plugin sets and clients, the Payone assistant has to be completed more than once. Only this ensures that the Payone payment methods are configured correctly and all functions such as event procedures and crons run smoothly in the background.

The following tables show you which assistants you have to complete in which plugin set. The upper row displays the configuration of the plugin sets and clients. The second row lists correspondingly, in which set the Payone assistant has to be completed for which client.

Important: The examples are not about either or. The assistant has to be completed several times for multi-clients because it always also has to be completed in the plugin set which is linked with the main client.

Example 1:

Your plugin sets and clients:

Plugin set 1 is linked with the main client

Plugin set 2 is linked with multi-client 1

Plugin set 3 is linked with multi-client 2

Complete the assistant:

Complete the Payone assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

Complete the Payone assistant in this plugin set for multi-client 1.

Complete the Payone assistant in this plugin set for multi-client 2.

Example 2:

Your plugin sets and clients:

Plugin set 1 is linked with the main client

Plugin set 2 is linked with multi-client 1 and multi-client 2

Complete the assistant:

Complete the Payone assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

Complete the Payone assistant in this plugin set for multi-client 1 and for multi-client 2.

Example 3:

Your plugin sets and clients:

Plugin set 1 is linked with the main client and to multi-client 1

Plugin set 2 is linked with multi-client 2

Complete the assistant:

Complete the Payone assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

Complete the Payone assistant in this plugin set for multi-client 2.

Example 4:

Your plugin sets and clients:

Plugin set 1 is linked with the main client, with multi-client 1 and with multi-client 2

Complete the assistant:

Complete the Payone assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

3. Adapting the plentyShop checkout

In the next step, an adjustment to your plentyShop checkout settings is necessary. These adjustments need to be made so that customers using Payone for payment processes can enter their date of birth (for secure invoice only) correctly. There are two ways to do this. You can either use the ShopBuilder or configure the Ceres plugin accordingly. Both ways are described below.

Adapting the ShopBuilder for the checkout:

  1. Select the widget category Customer data on your checkout ShopBuilder page.

  2. Select the widget Address selection.

  3. Click on the Settings () of this widget.

  4. Select also Date of birth next to the other needed address fields for Display input fields for invoice and delivery address.

  5. Save () the settings.

You can find additional information about the ShopBuilder in general as well as the widget category Customer data in the Online store section of the manual.

Adapt the plentyShop checkout for Secure Invoice:

  1. Go to Plugins » Plugin set overview.

  2. Open the plugin set you want to edit.

  3. Open the plugin Ceres.
    → The plugin detail view opens.

  4. Select Ceckout and My account in the Configuration menu.

  5. Set the toggle Toggle deprecated entries to active (green).

  6. Open the section Show invoice address fields in address form (DE).

  7. Activate the option Date of birth by selecting the checkbox.

  8. Save () the settings.

A field for entering the date of birth is now displayed for your customers in the checkout area.

Input errors

Make sure to carefully carry out these settings. Otherwise, your customers will not be able to complete the payment process using Payone in your online shop.

4. Linking template containers

The containers needed by default are automatically linked to your online shop during the setup with the Payone assistant. In the Plugin settings of the Payone plugin, template containers can also be set manually, if required. To do so, proceed as follows.

Linking template containers:

  1. Go to Plugins » Plugin set overview.

  2. Open the plugin set you want to edit.

  3. Open the plugin Payone.
    → The plugin detail view opens.

  4. Click on Container links.

  5. From the drop-down list, select the data provider you want to link.

  6. Select the container you want to link to the data provider to. → Pay attention to the information provided in Table 2.

  7. Repeat steps 5 and 6 for all data providers you want to link to containers.

  8. Save () the settings.

Table 2. Linking template containers
Content Explanation

Payone Order Confirmation Page Payment Data

Link this content to the container Order confirmation: Additional payment information to display the Payone payment methods on the order confirmation page in the online shop.

Payone Checkout JS

Link this content to the container Script loader: After script loaded to display the Payone payment methods during the checkout process in the online shop.

5. Customer classes and shipping profiles

Make sure the payment method is allowed in the customer classes and is not deactivated in the shipping profiles. For this, you should consider first for which customer classes and shipping profiles the payment method should be allowed. This can be set individually.

Permitting the payment method in a customer class:

  1. Go to Setup » CRM » Customer classes.

  2. Open the customer class for which you want to permit the payment method.

  3. Select the payment method from the list Permitted payment methods.

  4. Save () the settings.

  5. If needed, repeat these steps for other customer classes as well.

Checking payment method in existing shipping profiles:

  1. Go to Setup » Orders » Shipping » Settings.

  2. Click on the Shipping profiles tab.

  3. Open the shipping profile in which the payment method should be allowed.

  4. Check whether the payment method is selected in the Blocked payment methods area.

  5. Deselect the payment method if you want to allow it for this shipping profile.

  6. Save () the settings.

  7. If needed, repeat these steps for shipping profiles as well.

6. Setting up event procedures

Set up event procedures so that all needed data are sent to Payone. We recommend 2 event procedures for this.

6.1. Sending an automatic shipping confirmation to Payone

Set up an event procedure to send an automatic shipping confirmation to Payone as soon as you have shipped the order.

Event procedure and Authorisation method

Setting up the following event procedure is mandatory if you have selected the option Preauthorisation as Authorisation method in the basic settings. This event procedure is not necessary and cannot be used if you have selected the option Authorisation.

Setting up an event procedure
  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to Table 3.

  5. Save () the settings.

  6. Carry out the further settings according to Table 3.

  7. Activate the option Active ().

  8. Save () the settings.

Table 3. Event procedure for automatically sending shipping confirmations to Payone
Setting Option Selection

Event

Select the event after which an automatic shipping confirmation should be sent, e.g. Order change > Outgoing items booked.

Filter 1

Order > Payment method

Plugin: PAYONE

Procedure

Plugin > Payone

Send shipping confirmation

6.2. Automatically refunding Payone payments

Set up an event procedure to automatically refund a Payone payment.

Setting up an event procedure
  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to Table 4.

  5. Save () the settings.

  6. Carry out the further settings according to Table 4.

  7. Activate the option Active ().

  8. Save () the settings.

Table 4. Event procedure for automatically refunding Payone payments
Setting Option Selection

Event

Select the event that will trigger a refund.

Filter 1

Order > Payment method

Plugin: PAYONE

Procedure

Plugin > PAYONE

Send refund

To top