WooCommerce Integration Guide

Version: v2.11.0

📋 Navigation: Click on the tabs below to explore different sections

Introduction

Our WooCommerce plugin is regularly updated and provides a versatile, ready-to-use solution for easy online payment acceptance.

Supported Payment Methods

💳 Credit Cards

Visa, Mastercard, American Express
JCB, Diners Club

📱 Digital Wallets

Google Pay
Amazon Pay (v2)
PayPal and PayPal Express
PayPal v2 and PayPal Express v2
Alipay
WERO

🏦 PAYONE Solutions

PAYONE Secure Invoice
PAYONE Secured Payments
PAYONE Direct Debit
PAYONE Open Invoice
PAYONE Prepayment

🌍 Local Payment Methods

Klarna Payments
Ratepay Solutions
Bancontact
EPS, iDEAL
Przelewy24

Requirements

An active PAYONE account is required. If you don't have one yet, please contact us.

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 ▼

Field	Description
Merchant-ID	You will find your PAYONE Merchant ID at the top right of the PAYONE Merchant Interface (PMI) and on all PAYONE invoices.
Portal-ID	You can find the portal ID in the PAYONE Merchant Interface (PMI) under the menu item Configuration → Payment Portals
Subaccount-ID	You can find the ID in the PAYONE Merchant Interface (PMI) under the menu item Configuration → Accounts
Key	Please enter the key here to protect the data communication against manipulation. This must be identical to the key stored in the corresponding PAYONE payment portal.
Mode	Here you can specify for the respective payment type whether the payments are to be processed in test mode or whether they are to be executed "live". You can also configure the test mode for individual payment types.
Submit Cart	Here you can configure whether the shopping cart information should be transferred to the PAYONE platform for each request.
Activate PDF Download	If activated, a link will be offered after the order has been placed, via which the end customer can download the SEPA Mandate as a PDF file. This product must be ordered separately.
Dynamic Invoice Text	Specifies whether and (if yes) which dynamic text should appear on an invoice generated by PAYONE. The contents of the field are transferred in the parameter "invoiceappendix". The maximum length is 255 characters and different WooCommerce variables can be used as placeholders. You can use {{order}} to reference the current order number in WooCommerce in the request.
Dynamic Refund Text	You can specify the dynamic text that will appear on credits created by the PAYONE platform. (see above)
API-Log	Specifies whether the log for API calls from WooCommerce to PAYONE should be activated. The API logs may contain personal information. Please ask your legal advisor or data protection officer about data protection implications. Deactivated - no log is kept over API calls Activated - a log about the API calls is created
Transaction Status Log	Specifies whether a log is to be kept of the transaction status messages received from the shop system. Deactivated - no log of transaction status messages is kept Activated - transaction status messages from PAYONE platform are logged

The required data for the setup can be found in the PMI:

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.

Special Customizations

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 ▼

Field	Description
Credit Card Brand	Here you can activate the credit card brands to be used for checkout. You can also define user-defined names for the individual brands.
Minimum Validity of Card	Specifies the number of days a credit card used must still be valid for a transaction. Credits on expired credit cards are not possible.

User-defined display for the hosted iframe

The WooCommerce Extension offers the conformity with the "lowest" Compliance Level according to PCI DSS (SAQ A). Since in this compliance level all credit card data may only be entered in fields hosted by a PCI DSS certified service provider, our extension uses iFrames that are integrated into the checkout. However, these do not inherit the CSS of the shop template, but contain their own style. You can use the following settings to customize these fields.

Field	Description
Type	Numeric - Only numbers are allowed and for mobile devices the numeric keyboard is used input type="tel". Password - input type="password" Text - input type="text"
Digit Count	Length of the field in characters (HTML attribute size)
Max Digits	Maximum length of input (HTML attribute maxlength)
IFrame	Default - Uses width and height from standard style Custom - Uses width and height from the following fields
Width	CSS - Specify width
Height	CSS - Indication of height
Style	Default - Uses CSS specification from "Default Style" Custom - Uses CSS specification from the following field
CSS	Specification of CSS properties for the field. Deactivated when Standard is selected beforehand. All CSS properties except "url" are allowed. The following characters are prohibited: "\", "/", "?", "<" and ">"
Default Style
Text Input	CSS specification for all input fields (HTML input)
Select	CSS specification for all selection fields (HTML select)
Error Output
Error Output Active	Specifies whether card payment errors are to be specified in the checkout.
Error Output Active (Language)	Select the language in which the error message should be returned.