The PAYONE Payment Plug-in for Shopware enables the connection of Shopware 6.x to the PAYONE platform for secure and automated handling of all payment processes. The plug-in fits seamlessly into the standard checkout process of the Shopware online shop. In the Shopware administration area there are extensive configuration and administration options available.
Supported Payment Methods
The plug-in supports the processing of the following payment methods via the PAYONE platform.
UI Tabs |
---|
UI Tab |
---|
title | credit and debit cards |
---|
|
Visa | Mastercard | Maestro | American Express | JCB | Diners Club |
---|
Image Removed
| Image Removed
| Image Removed
| Image Removed
| Image Removed
| Image Removed
|
UI Text Box |
---|
|
all credit card transactions are PSD2 compatible! |
UI Tab |
---|
title | Online Bank Transfer |
---|
|
Sofort |
---|
Image Removed
|
UI Tab |
---|
|
SEPA |
---|
Image Removed
|
UI Tab |
---|
|
PayPal |
---|
Image Removed
|
UI Tab |
---|
title | Secured Payment Methods (factoring) |
---|
|
Paysafe Pay Later |
---|
Image Removed
|
Download and Installation
Requirements
To make successful requests to our platform, you'll need the follwing:
- An active Merchant Account. Don't have one yet? Contact us!
- An installed and running instance of Shopware 6. See here for further details.
- Some payment methods require additional sandbox accounts
Installation
Github and Composer
Section |
---|
Column |
---|
|
Column |
---|
|
UI Button |
---|
color | blue |
---|
newWindow | true |
---|
size | large |
---|
display | block |
---|
icon | download |
---|
title | Download from Github |
githubPAYONE-GmbH/shopware-6/releases Column |
---|
|
Our recommended installation method for advanced users is installation via composer and Shopware CLI:
Code Block |
---|
composer require payone-gmbh/shopware-6
php bin/console plugin:install PayonePayment
php bin/console plugin:activate PayonePayment
php bin/console cache:clear |
Shopware Store and Plugin Manager
After Installation the plugin shows up in the Shopware Plugin Manager
Image Removed
Configuration
Configuration in the PAYONE Merchant Interface
Transactionstatus URL
To send the transaction status to the correct address, the following must be entered in the PAYONE Merchant Interface (PMI).
Configuration > Payment Portals > YOUR_PORTAL > Advanced > TransactionStatus URL
UI Text Box |
---|
<shoproot>/payone/webhook |
Image Removed
Hash Calculation Method
Please make sure to set the hash calculation method to sha2-384 or "both".
Additional Response Data
In the General tab, set the Additional Response Data to "on" both for live and test.
Image Removed
Basic Plugin Settings
You can find the configuration of the PAYONE Plugin by clicking on Settings → Plugins → PAYONE
Image Removed
Image Removed
Field | Description |
---|
Saleschannel | Which Sales Channel should be used with this configuration? |
Merchant ID | Your Merchant ID |
Account ID | Your Su-Account ID |
Portal ID | Your Portal ID |
Key | Your Portal Key |
Live or Testmode | Global Live/Test Switch |
Payment Method Specific |
---|
Authorization Method | can be either
- Authorization
- Preauthorization
|
Integration Guide Shopware 6 |
Linchpin Teaser |
---|
title | Deutsch |
---|
type | 7 |
---|
url | https://docs.payone.com/x/VIIjAg |
---|
|
Integrationsanleitung Shopware 6 |
UI Text Box |
---|
|
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. |
Please see here for more Information on where to find your merchant credentials: Quick Start Guide - English
Status Mapping
The PAYONE Platform sends transactionstatus callbacks to the shop, which can inform you about the status of transactions. For example, a transactionstatus "paid" is sent after the cashflow was triggered during an authorized payment. To learn more about transactionstatus callbacks, please refer to this site: Parameter for the TransactionStatus query#Listofevents(txaction)
Image Removed
The Status Mapping Configuration lets you map Shopware order statuses to these transactionstatus messages.
Payment Method Management
You can activate and deactivate the payment methods via the standard Shopware menu in Settings → Shop → Payment. PAYONE payment methods use the prefix "PAYONE"
Image Removed
Payment Type Specific Settings
Every payment method can use their own set of portal credentials, so if you want to customize any portal data for a specific payment method, please use the corresponding configuration block.
Credit Card
Some payment methods like credit cards have custom field styling for the iframe-based input fields. You can change the field styling by creating a new plugin depending on this plugin via composer.
In the new plugin you can then define an overriding javascript plugin like this (example uses custom/plugins/MyPlugin/src/Resources/storefront/my-payone-payment/my-payone-payment.credit-card.plugin.js
):
Code Block |
---|
|
import PayonePaymentCreditCard from '../../../../../PayonePayment/src/Resources/storefront/credit-card/payone-payment.credit-card';
export default class MyPayonePaymentCreditCard extends PayonePaymentCreditCard
{
getFieldStyle() {
const style = super.getFieldStyle();
style.push('height: 300px');
return style;
}
getSelectStyle(){
const style = super.getSelectStyle();
style.push('background-color: black');
return style;
}
} |
Then you can register the overriding plugin in your custom/plugins/MyPlugin/src/Resources/storefront/main.js
:
Code Block |
---|
|
import MyPayonePaymentCreditCard from './my-payone-payment/my-payone-payment.credit-card.plugin';
const PluginManager = window.PluginManager;
PluginManager.override('PayonePaymentCreditCard', MyPayonePaymentCreditCard, '[data-is-payone-credit-card]');
// Necessary for the webpack hot module reloading server
if (module.hot) {
module.hot.accept();
} |
Paysafe Payments
Paysafe Pay Later Invoicing
Image Removed
Field | Description |
---|
Company Name | Please provide your company's legal name. This information is displayed in the supplementary notes to the privacy statement for this payment method. |
IBAN | The IBAN which is displayed next to the payment reference. (Unsure what goes in here? Contact your Paysafe Representative for assistance!) |
BIC | The BIC which is displayed next to the payment reference. (Unsure what goes in here? Contact your Paysafe Representative for assistance!) |
B2B Mode toggle | Activate this toggle, if you're planning on accepting B2B orders with this payment method. |
Paysafe Pay Later Installment
UI Text Box |
---|
|
Please make sure to always fill in this info, since it is used for the legal links in alle Paysafe payment methods |
Image Removed
Field | Description |
---|
Company Name | Please provide your company's legal name. This information is displayed in the supplementary notes to the privacy statement for this payment method. |
Channel Name | Username for the URL to the EU standard credit information hosted by Paysafe (Unsure what goes in here? Contact your Paysafe Representative for assistance!) |
Channel Password | Password for the URL to the EU standard credit information hosted by Paysafe (Unsure what goes in here? Contact your Paysafe Representative for assistance!) |
Orders
The PAYONE plugin sets the payment status of an order according to the set status mapping.
Image Removed
Collecting and Refunding Money
Collecting Money
Preauthorized transactions can be captured using the "Capture" button in the order details:
Image Removed
In this example, the payment status changes to "paid", according to the set status mapping.
Image Removed
Refunding Money
This paid order can now be refunded by using the "Refund" button in the order details.
Image Removed
Integrationquickfacts |
---|
TXURL | payone/webhook |
---|
Repo | https://github.com/PAYONE-GmbH/shopware-6/releases |
---|
Version | 1.0.1 |
---|
SHOPID | 5 |
---|
System | shopware6 |
---|
|
Table of Contents
Table of Contents |
---|
outline | true |
---|
indent | 2em