Versions Compared

Key

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


UI Steps


UI Step

Requirements

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


UI Step

Plugin Installation

You have 3 ways to install our plugin:

UI Expand
titleInstallation directly in Shopware - Admin
  1. "Buy" the free PAYONE plugin in the Shopware Store.
  2. Download our plugin in your shop under Extensions → My extensions.
  3. Install and activate the plugin.

Installation directly in Shopware - AdminImage RemovedImage Added


UI Expand
titleInstallation via Composer


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



UI Expand
titleInstallation via Github


Section


Column
width33%



Column
width33%

UI Button
colorgreen
newWindowtrue
sizelarge
displayblock
icondownload
titleDownload from Github
urlhttps://github.com/PAYONE-GmbH/shopware-6/releases


Column
width33%






UI Step

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

UI Text Box
typeinfo
<SHOPURL>/payone/webhook

Additional Response-data

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


UI Step

Shopware 6 - Admin configuration

  • Click on Settings → Extensions → PAYONE

Image RemovedImage Added

  • Please enter your access data here:

  • Please activate under Sales Channels → [used Sales Channel] → Payment and shipping the payment methods for your used sales channels:

  • Each payment method can be used with separate access data. These can be entered directly in the payment type.

Special adjustments

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

UI Expand
titlePAYONE Secure Invoice

PAYONE Secure Invoice

This payment method requires its own payment portal. Please enter a separate portal ID under Settings → Extensions → PAYONE → Payone Secure Invoice

A rule created during the plugin installation for the Rule Builder ensures that the payment method can only be used for the currency "Euro". If you have not installed the currency "Euro" in your store during the plugin installation, a random, non-existing currency ID will be linked to the condition, so that the rule will always fail. If you then create the currency "Euro" afterwards, you have to select the currency "Euro" in the condition "Currency is one of" under Settings → Rule Builder → Payone secure invoice.


UI Expand
titlePAYONE Prepayment

PAYONE Prepayment

To inform customers about the bank details, we have included a block with billing data in the invoice template. It makes sense to include this data in the order confirmation email template as well. We do not have a detailed instruction available currently.


UI Expand
titleUnzer Payments

Unzer Payments

To be able to offer Unzer, the payment methods must be additionally configured in the backend:

  • Unzer Rechnungskauf

Under Settings → Extensions → PAYONE → Paysafe Pay Later Invoice the following data must be stored: Company name (for the supplementary T&C), IBAN and BIC (both will be displayed next to the payment reference). Activate the B2B slider if you want to accept B2B orders.

  • Unzer Ratenkauf

Under Settings → Extensions → PAYONE → Paysafe Pay Later Installment the following data must be stored: Company name (for the supplementary GTC), channel name and channel password (both you get from Unzer).


UI Expand
titleApple Pay

Apple Pay

UnderSettings → Extensions → PAYONE → Apple Pay the following data must be stored: Supported Cards, ApplePay Merchant ID, ApplePay Display Name und Certificate Passphrase (the last three values you get from Apple).

Create the following files in the config folder: merchant_id.pem and merchant_id.key.

UI Text Box
typeinfo

You will receive the content of the files in the process of Apple Onboardings under point 3.

In addition, a subfolder .well-known must be created in the public folder. In this subfolder please put the file: apple-developer-merchantid-domain-association.txt

UI Text Box
typeinfo

You will receive the contents of the file after domain certification from Apple.


UI Text Box
typenote

ApplePay is only visible and usable on Apple devices.


UI Text Box
typetip

In addition to the configuration in Magento, it is also necessary to set up the corresponding certificates to operate Apple Pay as a payment method. You can find instructions for this here: Special Remarks - Apple Pay

Additionally, Apple requires validation of the store domain for Apple Pay. To do this, follow the instructions in the Apple Developer Portal:




UI Step

Payment methods setup

Activate the requested payment methods under Settings → Shop → Payment methods

Image RemovedImage Added


UI Step

Editing the orders

The PAYONE plugin sets the payment status of an order according to the set status assignment.

Capture

Preauthorized transactions can be captured using the "Capture" button in the order details.

Refund

The "Refund" button can be used to refund an order (in the "paid" status).

Partialcapture and -refund

You can partially enter or refund an order by selecting an order item and editing the quantity. The entry amount is adjusted dynamically. 

If you want to fully capture or refund the order, click "Complete Capture".

You can also directly enter the requested amount in the "Capture amount" field.

Captures and refunds are only possible after the store has received a transaction status for an order, therefore, the buttons for captures and refunds are grayed out directly after an order.


UI Step

Extended configurations

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

UI Expand
titleDetailed status mapping (global)

Detailed status mapping (global)

Under Settings → Extensions → PAYONE → Status Mapping you can individually assign the states to which the orders should be set as soon as the respective information is sent by the PAYONE platform.


UI Expand
titleDetailed status mapping (by payment method)

Detailed status mapping (by payment method)

Under Settings → Extensions → PAYONE you can individually assign the states for every payment method separatly. Please choose the payment method and activate "Display state mapping configuration".


UI Expand
titleCreditcard - CSS adjustments

Creditcard - CSS adjustments

The following customizations are not necessary to offer credit card payments. The possibility to customize the payment type visually in the frontend is described in the following:

You can change the CSS by creating a new plugin that depends on this plugin via Composer. Here you can then define an overriding JavaScript plugin like this one:

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



UI Expand
titleRight management

Right management

If you use Shopware's rights management, please give permission to all users. Under Settings → System → Users&permissions → Role create a new role or update an existing role. Activate the PAYONE transaction management right.







Quick Facts

Integrationquickfacts
TXURLpayone/webhook
Repohttps://github.com/PAYONE-GmbH/shopware-6/releases/tag/v3.12.0
Version3.12.0
SHOPID5
Systemshopware6

Table of Contents

Table of Contents
maxLevel3
include.*Requirements|Plugin Installation|PAYONE - Portal configuration|Shopware 6 - Admin configuration|Special adjustments|Editing the orders|Payment methods setup|Capture|Refund|Partialcapture and -refund|Extended configurations|Integration Quick Facts|Quick Facts|
outlinetrue
indent2em