Integration Guide WooCommerce

Introduction

Our WooCommerce plugin comes with regular updates and full integration support, offering a versatile out-of-the-box solution to accept online payments easily:

Currently supported payment methods:

Keep an eye on our Release Notes to stay informed about updates and new features (i.e. payment methods, features, integration modes) we have added to this plugin!

Check out our documentation to learn how to link your store with our platform to profit from all these features!

Current Release: v2.8.0

Requirements

An active PAYONE - Account is required. If you do not have one yet, please contact us.

Plugin Installation

You have 2 ways to install our plugin:

Installation directly in WooCommerce - Admin

Installation via Github

PAYONE - Portal configuration

To send the transaction status to the correct address, the log in to the PAYONE Merchant Interface (PMI).

Under Configuration → Payment Portals → YOUR_PORTAL → Advanced → TransactionStatus URL

From plugin version 2.1.0: <SHOPURL>/wc-api/payoneplugin/
For old plugin versions: <SHOPURL>/payone-callback/

Additional Response-data

Under General, set the Additional Response data for both Live and Test modes to "on".

Woocommerce - Admin configuration

Click on PAYONE. Please enter your access data here:

By clicking on "Test API setting" you can check if your data has been entered correctly.

Detailed description of each field
Payment methods setup

You can access the settings for the individual payment methods via the WooCommerce menu (WooCommerce → Settings → Payments). Payment methods provided by the PAYONE plugin are marked with the prefix "PAYONE".

 

Configuration Options

All payment methods offer certain basic options.

Field Description

Enable/Disable

Specifies whether the payment type is to be displayed in the checkout.

title

Specifies the name of the payment type in the checkout.

customer message

Here you can define an additional message to be displayed when you select the payment type.

Minimum Order Value

The payment type is only displayed from this shopping basket value onwards.

Maximum Order Value

The payment type is no longer displayed if the market-basket value exceeds this total.

Method of Authorization

Indicates whether the payment type is addressed by "authorization" or "preauthorization".

  • Authorization - Here the payment method is debited directly when ordering (where possible) and a claim is written on the PAYONE platform.
  • Preauthorization - As far as possible, payment will be reserved at the time of order. The payment has to be collected later in the order.
Which authorization method is used for which payment method can have an effect on the cash flow. Which method you should use depends strongly on the business model and the payment type.

Active Countries

In which countries should the selected payment method be active? By default, Germany, Austria and Switzerland are active. You can add or deselect further countries by "ctrl+click".

Use global settings

With this option, the global settings for the shop can be overwritten for specific payment methods.

  • Yes - the data active in the general settings will be used for this payment method.
  • No - After saving, the fields Merchant ID, Portal ID, Account ID, Key etc. appear again and can be filled with different data.

Some payment methods require special adjustments. The next points are only relevant to you if you use the specific payment method:

PAYONE Secured Invoice + PAYONE Secured Installment

PAYONE Credit Card

PAYONE Direct Debit
Editing the orders

Orders placed via the PAYONE Extension for WooCommerce are listed as usual in the order overview of WooCommerce. Order processing differs depending on the authorization method used to process the order.

Capture

Orders placed using the authorization method "Preauthorization" are given the status "On Hold" after the order has been placed.

 

Only a status change to "Processing" activates the claim on the PAYONE platform and initiates (where possible) the collection of funds. Set the status to "Processing" and click on the blue "Update" button on the right.

 

The collection is then initiated on the PAYONE platform and acknowledged in the order notes:

 

Possible errors can also be found in the Order Notes.

Reserved payments are not reserved indefinitely. You should therefore take care to set orders to "Processing" in good time after a preauthorization and thus collect the payment or write the claim. Here are some (non-binding) guide values for the validity of the reservation:
- Credit card - 7 days (sometimes longer, varies from bank to bank)
- PayPal - 29 days
- PAYONE Secure Purchase on Account - 28 Days
Refund

Credit notes use the familiar WooCommerce credit note process. A click on the button "Refund" in the order opens the menu for credit notes:

 

Here you can enter the amount credited and a reason. Important: "Refund manually" does not credit the money on the payment method, but only in WooCommerce. Use this option only if you do not want to transfer money back or if you use other ways than the PAYONE platform.

Due to limitations in the way that WooCommerce manages orders, the shop's standard tax rate for the entire credit amount is always transferred for credit notes with shopping basket transfer. This is especially important when the PAYONE platform takes care of document dispatch for you. This is the case, for example, with the PAYONE Safe Invoice payment method.
However, if you wish to credit a shopping cart that contains items with different tax rates or mixed tax rates, please use the credit function in the PAYONE Merchant Interface. There you have the option of creating individual shopping basket items together with the tax rate, which are then displayed correctly on the document. 
Extended configurations

Here you will find separate setting options that allow you to customize our plugin more precisely to your needs.

Logs