- Created by PAYONE Admin, last modified on 2022-05-12
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:
- Download the free PAYONE plugin from the WordPress Store.
- Upload the plugin in your store under WooCommerce → Plugins → Add New.
- Install and activate the plugin.
- Extract the archive into: /wp-content/plugins/payone-woocommerce-3
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/
Do not set the field procedure hash value check to sha2-384, otherwise no communication between store and PAYONE is possible.
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:
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. GDPR Note
|
Transaction Status Log | Specifies whether a log is to be kept of the transaction status messages received from the shop system.
|
The required data for the setup can be found in the PMI
Permalinks in Wordpress
It is important that the Permalink settings under Settings → Permalinks are not set to "Plain".
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".
Recurring 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".
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.
|
Special adjustments
Some payment methods require special adjustments. The next points are only relevant to you if you use the specific payment method:
Creditcard
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 markers. |
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 |
|
digit count | Length of the field in characters ( HTML attribute size ) |
max digits | Maximum length of input ( HTML attribute maxlength ) |
iFrame |
|
width | CSS - Specify width |
Height | CSS - Indication of height |
style |
|
CSS | Specification of CSS properties for the field All CSS properties except "url" are allowed. The following characters are prohibited: "\", "/", "?", "<" and ">" |
default style |
|
iFrame |
|
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. |
PAYONE Direct debit
Field | Description |
---|---|
Check Bank Data | Specifies whether the IBAN is to be checked before the payment is made. |
Use PAYONE Mandate Management | Specifies whether mandate management is to be used by PAYONE.
Without a valid mandate, the customer can revoke the direct debit up to 13 months after payment via the bank! |
Download mandates as PDF | If this function is activated, the SEPA Mandate is offered to the end customer for download after the order process (only if PAYONE Mandate Management is active). |
List of supported bank countries | Here you can define from which countries SEPA direct debits should be possible. |
PAYONE Secure Invoice
This payment method must use a different payment portal together with the corresponding portal key. In addition, the transfer of the shopping basket data is always active here. In order for the payment method to work as desired, it is therefore important that you enter the data from the "secured invoice" payment portal in your PMI in the fields provided for this purpose.
Field | Description |
---|---|
Portal ID | Portal ID of the dedicated payment portal for the PAYONE secured invoice from your PMI |
key | The corresponding key |
With this payment method, careful selection of the authorization method is particularly important. Since with "Authorization" the demand is written immediately on the PAYONE platform, the platform also immediately sends a corresponding invoice. You should therefore use this authorization method above all if you perform the service immediately.
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
API log
Under "API-Log" you will find the detailed API calls that WooCommerce sends to the PAYONE platform. Here you will also find detailed technical information on the response to the PAYONE API.
Transaction Status Log
The Transaction Status Log displays all feedback on payments made that the shop receives from the PAYONE API.
Quick Facts
Payment methods + Features
Visa
Mastercard
American Express
JCB
Diners Club
Maestro International
China Union Pay
Alipay
paydirekt
PayPal
PayPal Express
Cash On Delivery
PAYONE Direct Debit
PAYONE Invoice
PAYONE Prepayment
Bancontact
EPS
Giropay
iDEAL
PostFinance Card
Sofort
Klarna Pay Later
Klarna Pay Now
Klarna Slice It
PAYONE Secure Invoice
Open Source
Transactionstatus URL:
<SHOPURL>/wc-api/payoneplugin/
Latest Release
- New payment method: PayPal Express
- New payment method: Bancontact
- New payment method: iDEAL
- Using WC_API for callbacks
- The Transactionstatus URL has to be changed to <SHOPURL>/wc-api/payoneplugin/.
- The old Transactionstatus URL is temporarily still reachable.
Bugfix(es)
- Better generating of unique reference numbers
- TX-Log corrections
tested with
wordpress version: 5.9.2
woocommerce version: 6.4.0
Download
Table of Contents
- No labels