Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General information

The PAYONE Payment Plug-in for Shopware enables the connection of Shopware 6.2.0 and up 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.

Download and Installation

Requirements

To make successful requests to our platform, you'll need the follwing:

  1. An active Merchant Account. Don't have one yet? Contact us!
  2. An installed and running instance of Shopware 6. See here for further details.
  3. Some payment methods require additional sandbox accounts

Installation

Github and Composer

Section Column
width33%
Column
width33%
UI ButtoncolorbluenewWindowtruesizelargedisplayblockicondownloadtitleDownload from Github


Linchpin Teaser
titleEnglish
type7
urlhttps://
github
docs.payone.com/
PAYONE-GmbH/shopware-6/releases Column
width33%

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

FieldDescriptionSaleschannelWhich Sales Channel should be used with this configuration?Merchant IDYour Merchant IDAccount IDYour Su-Account IDPortal IDYour Portal IDKeyYour Portal KeyLive or TestmodeGlobal Live/Test SwitchPayment Method SpecificAuthorization Method

can be either

  • Authorization
  • Preauthorization
UI Text Box
typeinfo

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.

Transmit order number in narrative text

Indicates whether the order number should be transferred in the payment method's narrative text. If the option is deactivated, the narrative text is deducted from the corresponding field in your PMI payment portal

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

Afterwards you can activate the payment methods for your used sales channels in the sales channel settings:

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
languagephp
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
languagephp
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();
}

Prepayment

For customers to know where they have to wire the money, we've introduced a block of clearing data in the invoice template. So to inform customers of the bank data you can generate an invoice and send it to them. Later versions of Shopware 6 will also allow clearing data in a payment confirmation mail template. We'll implement this as soon as it becomes available.

Paysafe Payments

Paysafe Pay Later Invoicing

Image Removed

FieldDescriptionCompany NamePlease provide your company's legal name. This information is displayed in the supplementary notes to the privacy statement for this payment method.IBANThe IBAN which is displayed next to the payment reference. (Unsure what goes in here? Contact your Paysafe Representative for assistance!)BICThe BIC which is displayed next to the payment reference. (Unsure what goes in here? Contact your Paysafe Representative for assistance!)B2B Mode toggleActivate this toggle, if you're planning on accepting B2B orders with this payment method.
Paysafe Pay Later Installment
UI Text Box
typewarning

Please make sure to always fill in this info, since it is used for the legal links in alle Paysafe payment methods

Image Removed

FieldDescriptionCompany NamePlease provide your company's legal name. This information is displayed in the supplementary notes to the privacy statement for this payment method.Channel NameUsername 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

Partial Captures and Refunds

You can partially capture or refund an order by selecting an order item and editing the quantity. The capture amount will be dynamically adjusted

Image Removed

You can capture or refund an oder in full by clicking "Full Capture". You can also directly type the desired amount in the "Capture amount" field. Captures and Refunds are only possible after the shop receives a transaction status for an order, so the capture and refund buttons will be greyed out directly after an order.

Integrationquickfacts
TXURLpayone/webhook
Repohttps://github.com/PAYONE-GmbH/shopware-6/releases/tag/v2.3.0
Version2.3.0
SHOPID5
Systemshopware6

Table of Contents

Table of Contentsoutlinetrueindent2em
x/N4IjAg
Integration Guide Shopware 6



Linchpin Teaser
titleDeutsch
type7
urlhttps://docs.payone.com/x/VIIjAg
Integrationsanleitung Shopware 6