Page tree
Skip to end of metadata
Go to start of metadata

General information

The PAYONE Payment Plug-in for Shopware enables the connection of Shopware 4.x and higher to the PAYONE platform for secure and automated handling of all payment processes.
The plug-in supports over 20 national and international payment methods and offers integrated risk management services to minimize the risk of non-payment. The payment type portfolio can be dynamically controlled depending on the creditworthiness of the respective buyer.
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. All functions of the plug-in can be configured individually and according to requirements.

Functional Description

Supported Payment Methods

The plug-in supports the processing of the following payment methods via the PAYONE platform.

VisaMastercardMaestroAmerican ExpressJCBDiners ClubDiscover

Information: Depending on the respective acceptance contract, other payment methods such as Visa Electron, Visa Debit and other cards can also be processed via the aforementioned payment methods. Please contact us if you need further information.
Verified by VisaMasterCard SecureCodeAmerican Express SafeKey

GiropaySofortEPSiDEALPostFinancePrzelewy24

SEPAPrepaymentInvoiceCash on Delivery

PayPalPaydirektAmazon PayMasterPassAlipay

PAYONE Secure InvoiceKlarnaRatePayPaysafe Pay Later

Barzahlen

Risk Management

The following risk management services are supported by the plug-in:

Address Check Basic (20 countries)

  • Check of the billing address for existence including address correction
  • Check of the delivery address for existence including address correction

Address Check Person (Germany only)

  • Checking the billing address for the existence of the address and for postal deliverability (name, address) including address correction
  • Checking the delivery address for the existence of the address and for postal deliverability (name, address) including address correction

POS blocking file (direct debit Germany)

  • Checking of account connections against blocking files from stationary trading

Credit assessment (Germany)

  • infoscore (hard characteristics only)
  • infoscore (all characteristics)
  • infoscore (all features incl. boni score)
  • Boniversum Address validation, identification (Premium) (address validation and identification)
  • Boniversum VERITA Premium Ident S incl. address validation, identification (premium) and special addresses (address validation, identification, score value, special address)
In order to use the aforementioned risk management services, the Protect module of the PAYONE platform must be commissioned.
The plausibility and validity check of bank account connections (bank account check) and credit card numbers using LUHN checks (credit card check) is used for processing payments by direct debit and credit card regardless of the functionalities of the Protect module.
In addition, additional risk management services can be used to prevent fraud via the PAYONE platform (IP Check, BIN Check, Velocity Check, Risk Matrix, etc.).

Credit rating-dependent control of the payment portfolio

The PAYONE Payment Plug-in for Shopware allows you to control which payment methods are offered to your customers, depending on their creditworthiness. The check takes place in real time for each individual buyer during the checkout process.
The settings can be defined differently for each payment type so that the risk checks are only carried out under certain conditions and a payment type is only offered under certain conditions.

Integration in checkout and connection types (interfaces)

The payment plug-in fits seamlessly into Shopware's existing checkout process. The communication and data transfer takes place in the background - not visible to the buyer - between the plug-in and the server API of the PAYONE platform. With the credit card payment method, data is transferred during the checkout process for the verification and secure storage of card data via the Client API of the PAYONE platform.
Feedback on the status of processed transactions is provided via the transaction status of the PAYONE platform, which is processed by the plug-in to synchronise orders in shopware with their current status.

Logging

All communication with the PAYONE platform is logged and can be viewed in the Shopware administration area for support, testing and debugging purposes:

  • Risk Management Services
  • Payment processing (via Server API interface)
  • transaction status

An exception to this are requests sent via the Client API. This only applies to credit card verification during the checkout process.

Configuration and management options of the plug-in

The plug-in provides a new menu item PAYONE in the Shopware administration area. All configuration and management options as well as protocols, logs and information are centrally located in this.

Download and Installation

Compatibility and Requirements

PAYONE Payment Plug-in:

  • from Shopware version 4.0.5 Plug-in version 2.x

Please make sure that you always use the latest version of the payment plug-in. PAYONE only provides support for the current version of the integration.

Shopware:

  • Edition: Community, Professional or Enterprise Edition
  • Version: Version 4.0.0 or higher

PAYONE merchant account:

  • PAYONE Processing or PAYONE Business
    • Server API interface
    • Client API interface (optional)

(if credit or debit cards are to be processed)

  • Payment methods as required
  • Optional: Protect module (if risk management is to be used)
  • Optional: further PAYONE modules (Accounting, Invoicing, Collect, Contract, Billing)

If you do not yet have a PAYONE Merchant account, please contact us. Upon request, we will gladly provide you with a test account.

Download and Installation

Shopware Store

The PAYONE Plug-in can be downloaded free of charge from the Shopware Store:

You can install the plug-in directly via the Plug-in Manager and then all the functions of the PAYONE Payment Plug-in for Shopware will be available to you.

Github

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 > TransactionsStatus URL

https://www.example.com/MoptShopNotification/


Configuration

After successful completion of the installation described in the previous chapter, the PAYONE menu item is available in the administration area of your Shopware backend under Customers > Payments.

Payment Type Configuration

After selecting the Configuration menu item, you can create a separate configuration for each payment type contained in the plug-in. The default setting is All (global). This means that these settings affect all payment types and that these are predefined as default values when payment types are configured separately. If you have created a separate configuration, the setting All (global) no longer applies.

If you have made changes to a payment type that differs from the global settings, you can recognize this by the red color of the payment type.

General Information

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

Please enter the ID of the PAYONE payment portal you want to use to process the payments.
The Portal ID can be found in the PAYONE Merchant Interface (PMI) under the menu item Configuration > Payment Portals.

Sub-Account ID

Please enter the ID of the sub-account you want to use to process the payments.
The ID can be found 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.

operating 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.
Note: Please note that the defined test data must be used for the test mode.

authorization

Pre-authorizationWhenselecting "Pre-authorization", the amount to be paid is reserved in the course of the order. In this case, the debit must be initiated in a second step when the goods are delivered (Capture). The receivable is only posted after the capture has been carried out.
AuthorizationWhen"Authorization" is selected, the amount tobe paid is collected immediately when the order is placed. The receivable is immediately booked on the PAYONE platform.

Note: With the online transfer types giropay, SOFORT Überweisung, eps, PostFinance and iDEAL, payment is made in full even if "Preauthorization" is selected. In this case, the claim is to be booked separately by "Capture" despite this.

shopping basket handover

Here you can configure whether the shopping cart information should be transferred to the PAYONE platform for each request.
Note: This setting is required if you have ordered the Invoicing module from PAYONE.

Request credit card check digit

Determines whether the credit card verification number is queried. This is only possible if the acquirer allows it.

Check bank data

Here you can specify whether a bank account check is to be performed. This option is available only when the Direct Debit payment type is selected.

Show additional account number/ bank code?

Here you can configure whether fields for account number and bank sort code should be displayed in addition to the fields for IBAN and BIC when paying by direct debit. This is only available for German bank accounts.

Activate mandate allocation?

Here you can specify whether the SEPA Mandate Manager should be used. A check of the bank details is obligatory. A check against the POS lock list is not possible.

Download mandate as PDF?

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.
Note: This product must be ordered separately.

Klarna Store ID

Specific store IDs must be configured for the Klarna payment method. You can obtain these store IDs from Klarna. Please note that for the payment method Klarna the delivery address must be the same as the billing address. You can enforce this with Shopware Risk Management.
Note: The store ID can only be configured if the payment method Klarna is selected. Please also note that you must duplicate the payment method for each additional store ID (for example, for several countries). Please refer to chapter 4.2.2 for further information.

Klarna Campang Code

Specific campaign IDs must be configured for the payment method Klarna Installment Purchase. These campaign IDs refer to a so-called campaign at Klarna, in which term, interest rate, country, currency and other information for an installment purchase are specified. Please note that for the payment method Klarna installment purchase the delivery address must be the same as the billing address. You can enforce this with Shopware Risk Management.
Note: The campaign code can only be configured if the payment method Klarna Installment purchase is selected. Please also note that you must duplicate the payment method for each additional campaign code (e.g. for multiple countries, maturities or currencies). Please refer to chapter 4.2.2 for further information.

Saving the AGB confirmation

The following options are available:

  • Off
  • Global
  • On the Confirm - Page

    Off - switches off the saving of the AGB confirmation completely.
    Global - Enables global storage.
    On the Confirm page - Only on the Confirm page the saving of the AGB is activated.

Show PayPalECS button on shopping cart page

This option activates the PayPal Expresscheckout button on the shopping cart page.
Selection of:

  • Yes
  • No
    Note: This option can only be selected if the payment method PayPal is selected.

 

Note: The Payolution options can only be selected if a Payolution payment method is selected.

Payolution Company Name

The full name of the company must appear here. The name will be used in the privacy policy.

Payolution B2B Mode

If the B2B mode is activated, it is automatically assumed that it is a B2B transaction if the "Company" field was executed during address entry. To check the creditworthiness of the company, further information such as the commercial register number is then requested in the checkout.

Payolution Username

In order to retrieve the installment purchase draft contract, the user name assigned by Payolution (usually dealer name installation) must be stored here.

Payolution Password

The password assigned by Payolution must be stored here in order to retrieve the installment purchase draft contract.

Paydirekt Overcapture

This setting enables you to increase the original order value in the reservation and subsequent collection procedure and to collect up to a maximum amount. This maximum amount is displayed on the paydirekt pages.
Note: This setting only applies to the payment type paydirekt.

Use Shopware- Order number

Select Yes/No. This setting, if activated or set to Yes, causes an order number generated by the plugin to be reported as a reference to PAYONE, but the order number generated by shopware.
Note: This order number must always be unique and cannot be used again. Make sure that the correct and not already used order number range is active.

PayPal ECS Button


Click on Payone PayPal to open the following window:

Field

Description

Add

The Add button adds another button for a country.

Delete selected entries

Deletes selected entries

Language

Button language

PayPal Button

Path to the image file of the button

default

If the checkbox is activated, this is considered as fallback for all other languages for which no button has been defined.

If no image file is available for at least one country, the PayPal ECS button is not displayed in the shopping cart. There must be at least one button and it must be marked as default.

Duplicate payment type

The standard configuration of the payment methods will continue to be carried out via standard shopware functionality. At this point, you can also copy the payment type for a separate use with a subshop or other reasons such as country assignments.


After duplication, you can assign a different name to the payment method and assign it to a country or another subshop.

Please do not change the name of the payment method (here mopt_payone__cc_visa), as this is required for using the correct routines. After the duplication, a numeric suffix is appended to the name, which is necessary for the uniqueness of the names.

In the PAYONE configuration, the duplicated payment type is displayed in the dropdown menu as Description & Name Combination. To configure this payment type, select it from the dropdown menu.

Credit Card usage

PAYONE Client API


After clicking on Payone credit card configuration, the following window appears:

Field

Description

Add

The Add button adds another configuration.

Delete selected entries

Deletes selected entries

shop

The title of the corresponding shop

Only one configuration per shop is possible.

query type

Type of request

  • hosted-iFrame
  • AJAX

General configuration

Selecting Edit (Pen) or Add opens a window with the following parameters:

Field

Description

Integration type

Selection of:

  • hosted-iFrame (strongly recommended!)
  • AJAX

Make sure to always use "hosted iFrame". Only merchants with a PCI DSS certification level of SAQ A-EP or greater are allowed to use AJAX. We still strogly suggest using hosted iFrame!

For more information on this matter please refer to this page.

Default

Determines whether the current configuration is to be used as the default.

merchant ID

Your Merchant ID

portal ID

The Portal ID used to transfer credit card data.

subaccount ID

The subaccount ID used to transfer credit card data.

key

The portal key used to transfer credit card data.

live mode

Specifies whether credit card data should be transferred in live mode.

check creditcard CVC

Should the card verification code (CVC) be queried?

minimum validity

Minimum validity in days a card may still have in order to be able to order

For retail merchants, this value can be just above the revocation period, so that credits still work even if the card has expired in the meantime.
Auto Credit Card Type DetectionDecides whether the customer is asked to provide their card type or if the card type should be automatically detected by PAYONE.
Usage of Auto Card Type Detection

Here's how our automatic card type detection works. Using this new feature can help with conversion, since the customer has less fields to worry about. We also give visual guidance as to which brands are supported by the shop.

Without the automatic detection, the customer must provide the card type of their credit card.

When the feature is turned on, all configured credit card brand logos are loaded from our CDN and displayed above the cardpan field. Our platform determines and highlights the used brand while typing in the card number.

In the case of an unknown number, we show a warning:

This case can occur if the customer types in a genuinely wrong number, unsupported characters or a number from a very new BIN range. If the customer is confident in their card number, they can click on the icon of their brand to manually select the card type.

If the customer wants to use a card that is unsupported by the current shop configuration, we show an error message asking the customer to use a card that is supported.

Field Configuration

The Shopware Plugin offers you 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

field type

Selection of:

  • Numeric
  • password
  • text
  • choice

number of characters

Number of characters in width of the input field

Number of characters Max

Maximum allowed number of characters

iframe

Selection of:

  • Standard (uses the standard style)
  • User defined

iFrame Width

Specifying the width in CSS

iFrame Height

Indication of height in CSS

style

Specification of:

  • Standard (uses the standard style)
  • User defined

CSS

Specify CSS to format the field in question.

If you use the CSS attribute url, the field in question is not displayed

Default Style

FieldDescription

Fields: input

Specification of CSS for the standard formatting of all input fields.
The following CSS can be used in the Shopware standard template:

box-shadow:inset 0 1px 1px 1px #dadae5;background:#f8f8fa;border:1px solid #dadae5;border-top-color:#cbcbdb;line-height:19px;font-size:.875rem;width:85%;padding:.625rem .625rem .625rem .5625rem .625rem;color:#8798a9;

Fields: select

Specification of CSS for the formatting of all selection fields
The following CSS can be used in the Shopware standard template:

box-shadow:inset 0 1px 1px 1px #dadae5;background:#f8f8fa;border:1px solid #dadae5;border-top-color:#cbcbdb;line-height:19px;font-size:.875rem;width:85%;padding:.625rem .625rem .625rem .5625rem .625rem;color:#8798a9;

iFrame Height

Specification of the standard height in CSS for all fields

iFrame Width

Specification of the standard height in CSS for all fields

Error output

FieldDescription

active

Activates the error output

Language

Select the language in which the error message should be displayed.

Ensuring Maximum Conversion With 3D Secure 2.0

Starting in mid-September 2019 Issuers demand more data during payment requests for more granular risk management and better fraud protection. While you can find more information here, you can make these configuration changes to ensure maximum conversion and frictionless credit card payments for your customers:

Make sure 3-D Secure is active in your Merchant Backend

Submit cart items for credit card orders

Request the following info during checkout

  • phone number
  • shipping address
  • complete billing address

Most of these are on by default, but phone number isn't.

Configuration Payone RatePay (purchase on account and installment purchase)


For RatePay, you need to enter some additional configuration data that RatePay has specified in order for the payment method to work smoothly. Use the "Add" button to add another RatePay configuration:

Field

Description

shopid

The shop ID specified by RatePay. This represents a configuration data record (country, currency, interest, maturities, etc.).

currency

Currency to be used for this shop ID

Installment purchase mode

Prepayment: The buyer must transfer the instalments to an account designated by RatePay.

Direct debit: The installments are collected from the buyer's account by direct debit.
This setting has no effect on the other RatePay payment methods (invoice, direct debit).

Save the configuration and then retrieve the other data from RatePay using "download Ratepay Configuration".

Amazon Pay Configuration


For Amazon Pay, you need to enter some additional data to ensure that the payment method works smoothly.

Integration Settings in Seller Central
Please enter the following URL under Integrator-URL in the item "Integration settings" in Seller Central: https://gpc-sys.pay1.de/gpc/amazon/1.0/notify - the "Seller URL" may remain empty. This URL ensures that the shop receives all notifications from Amazon.

Also please make sure to store all your shop URLs as allowed Javascript Origin in Seller Central

Additionally, the Allowed Return URL has to be set to <shoproot>/moptPaymentAmazon


Add a new Amazon Pay configuration by clicking "Add item".

Field

Description

Client

The client ID from your Amazon Seller Central profile is automatically entered here after saving.

Seller

After saving, the seller ID from your Amazon Seller Central profile is automatically entered here.

Button Type

Here you can select which button should be displayed in the shopping cart and in the sidebar.

Button color

Here you can select in which color the button in the shopping cart and in the sidebar should be displayed.

Amazon mode

Here you can select in which mode Amazon Pay transactions should be carried out:

  • Asynchronous On Failure (default): The transaction is first tried in synchronous mode. This means that an attempt is made to obtain a direct confirmation from Amazon Pay for the transaction. If this is not possible, the asynchronous mode is tried. Amazon Pay confirms the transaction later when enough data is available. It may also be possible to reject the transaction at a later date. This is indicated in the payment status.
  • Always Synchronous: The transaction is only tried in synchronous mode. If Amazon Pay rejects the transaction, the buyer receives immediate feedback and can choose another payment method.|
Packstation ModeHere you can define if "DHL Packstation" addresses are allowed when using Amazon Pay

Click "save" after you have defined your parameters.

Download the current Client- and Seller IDs from the PAYONE platform by selecting the entry and clicking on "Download Configuration"

Make sure the checkbox is checked before clicking the button

If everything went correctly, you should see your Client- and Seller ID in the table:

You can now configure the payment method as usual.


Credit rating and address check

Please note that you can only use the following options if you have ordered the Protect module from PAYONE. The use of credit checks and address checks entails variable costs per transaction, which you can see in your contract.
Please make the settings for the credit check with caution. The credit check is carried out after the personal data has been entered and influences the payment methods offered to your customers in the checkout process. You should only use the credit standing check for payment types that entail a payment default risk for you (such as open invoices or direct debits). You configure this using the setting Traffic light value / Score in the configuration of the relevant payment type. You should also indicate in your shop in an appropriate manner that you are conducting credit checks via infoscore Consumer Data GmbH.

Address Validation

Here you can determine whether and in which form the address checks should be carried out and how the Shopware eShop should behave if certain results apply.

Field

Description

active

Here you can activate/deactivate the address check.

operating mode

Here you can specify whether the address check is to be carried out in test mode or live.
Note: Please note that the defined test data must be used for the test mode.

billing address

Do not check
No address check is performed.
basic
Address check for existence (street number, postcode, city, country) as well as addition and correction of address (possible for addresses from Germany, Austria, Switzerland, Netherlands, Belgium, Luxembourg, France, Italy, Spain, Portugal, Denmark, Sweden, Finland, Norway, Poland, Slovakia, Czech Republic, Hungary, USA, Canada).
person
Checking whether the person is known at the address given, checking the existence of the address and supplementing and correcting the address (Germany only).

delivery address

Do not check
No address check is performed.
basic
Address check for existence (street number, postcode, city, country) as well as addition and correction of address (possible for addresses from Germany, Austria, Switzerland, Netherlands, Belgium, Luxembourg, France, Italy, Spain, Portugal, Denmark, Sweden, Finland, Norway, Poland, Slovakia, Czech Republic, Hungary, USA, Canada).
person
Checking whether the person is known at the address given, checking the existence of the address and supplementing and correcting the address (Germany only).

Automatic correction

If Yes is selected, an address corrected by the PAYONE platform will be adopted. Not otherwise. In addition, there are options here that the user can agree to a correction or be prompted to enter the address again.

wrongdoing

Here you can define what should happen if there is a technical error. For example, the address validation is not available or reachable.

Minimum value of goods

Market-basket value from which an address check is carried out.

Maximum value of goods

Shopping basket value up to which an address check is carried out.

validity

The duration in days for registered users in the shop for which the result of the verification is valid.

error message

Here you can define which message is displayed to the user if an incorrect entry has been made.

person status mapping

Below are listed the individual possible results of address verification person to whom you can assign each of the traffic light values:

  • red
  • Yellow
  • green

to the other. In conjunction with the setting in the Risk area, this means that payment types are not available to the customer or are hidden by this traffic light value.

Please note that PAYONE requires the Protect module for your merchant account to be commissioned and activated in order to use these options.

Credit Assessment

Field

Description

active

Here you can activate/deactivate the credit standing check.

operating mode

Here you can specify whether the credit standing check is to be carried out in test mode or live.
Note: Please note that the defined test data must be used for the test mode.

Time of examination

Select the time of the check here.

This setting only applies if the value "All (global)" is selected for "Applies to payment type".

Type of examination B2C

infoscore (hard characteristics)
Check for hard characteristics via Infoscore (e.g. consumer insolvency proceedings, arrest warrant for affidavit or enforcement of affidavit)
infoscore (all characteristics)
Examination for so-called "hard" negative features (see above) and "medium" negative features (e.g. order for payment order, enforcement order or enforcement) and "soft" negative features (e.g. collection dunning procedure initiated, continuation of out-of-court collection dunning procedure after partial payment, discontinuation of out-of-court collection dunning procedure due to hopelessness)
infoscore (All Features + Boniscore)
Checking for all characteristics (see above) and delivery of the BoniScore, which as a score value enables a higher selectivity for existing negative characteristics.
Boniverse VERITA Score
Check for VERITA score via Boniversum

Type of examination B2B

Determines whether corporate customers are to be checked. The definition is based on the selection of the end customer during registration or checkout. ("I am a private customer/business customer")
credit
Examination via Schufa "short" (separate contract may be necessary)
No test
B2B customers are not checked

Default value for new customers

Here you can define the traffic light value for new customers.

Boniversum unknown

Here you can define the traffic light value for customers who are unknown to Boniversum (only applies when using the check type "Boniversum").

validity

Number of days for which the credit standing value returned is valid. No new credit checks will be carried out for the set period for the registered shop buyer / user concerned until the set period expires.

wrongdoing

Here you can define what should happen if a technical error occurs. For example, the credit assessment is not available or attainable.

Minimum value of goods

Market-basket value from which a credit check is carried out.

Maximum value of goods

Market-basket value up to which a credit check is carried out.

hint text

Enter here the text to be shown to the buyer when a credit check is performed for him.

consent request

Enter here the text of the question asked to the customer to agree to a credit check.

A/B Test

Here you can define the number of checks to be performed each n'th time.

Please make the settings for the credit check with caution. Incorrect configurations can result in errors in the checkout process and unwanted costs due to an increased number of queries and an unnecessarily high risk of payment defaults.

You should only use the credit rating check for payment types that entail a payment default risk for you (such as open invoices or direct debits). You should indicate in your shop in an appropriate manner that you are conducting credit checks via infoscore Consumer Data GmbH or Creditreform Boniversum GmbH.

Payment Status

Here you can define for each transaction status reported by the PAYONE platform for a payment, which status the order should have in Shopware.


For further information about transaction status callbacks, please refer to this site of our Server API documentation.

Transaction Status Forwarding

Here you can assign a separate forwarding URL to each payment status message of the PAYONE platform (transaction status), if necessary. This is always necessary if other systems in your system environment also require this payment information.

Payment Methods

When you install the PAYONE Payment Plug-in for Shopware, all available PAYONE payment methods are automatically created in your shop. For easier identification, these initials are created with the prefix "PAYONE". However, you can change this easily by changing the name of the payment type. All settings at this point follow the Shopware standard and can be found in the Shopware Wiki (http://wiki.Shopware.de).

Important for the SEPA Direct Debit payment method
If you want to use the "SEPA Direct Debit" payment method, you should ensure that you specify the countries from which you want to draw direct debits in the country selection. If no country is selected, the payment type is displayed to all customers. This can confuse customers from non-SEPA countries. In addition, the selection list of the account country in the checkout is then empty.


Default Payment Type

In the standard version of Shopware, the "Shopware advance payment" is defined as the standard payment type. However, you can also configure this payment method to a payment method provided by the plug-in.

Using payment methods with clearing data (prepayment, invoice, Paysafe, etc.)

Read out clearing data

The clearing data is stored in the table s_order_attributes in the column mopt_payone_clearing_data_ jsoncoded. The column orderID contains the ID of the corresponding order, which is stored in the table s_order. The data can be read, for example, with the following SQL statement:

Sample Query
SELECT mopt_payone_clearing_data FROM s_order_attributes WHERE orderID = desired OrderID

The clearing data can then be decoded again, but most programming languages provide standard functions.

PHP
json_decode()
JS
JSON.parse()

Display prepayment clearing data in e-mail template

All email templates can be customized under Settings > Email Templates. The template for the order confirmation e-mail can be found under System eMails > sORDER.
There are 2 templates; one for text emails and one for HTML emails.

Customize text e-mail template

You can customize the templates depending on the used payment method. To customize the templates, the internal name of the used payment method has to be used. You can find the names in the payment methods overview:

The following example will use prepayment, but can be customized for invoice etc.

Please search the template for the following block (in principle the additional information can be inserted at any controller):

Smarty
{if $additional.payment.name == "prepayment"} 
	Our bank details: 
	{config name=bankAccount} 
{/if}

and insert this block:

{if $additional.payment.name == "mopt_payone__acc_payinadvance (or other payment name)"}
	{if $additional.moptPayoneClearingData}
		Our bank details:
		account holder:	{$additional.moptPayoneClearingData.clearing_bankaccountholder}
		bank account: 	{$additional.moptPayoneClearingData.clearing_bankaccount}
		bank code:		{$additional.moptPayoneClearingData.clearing_bankcode}
		IBAN:        	{$additional.moptPayoneClearingData.clearing_bankiban}
		BIC:         	{$additional.moptPayoneClearingData.clearing_bankbic}
		Bank:        	{$additional.moptPayoneClearingData.clearing_bankname}
		reference:		{$additional.moptPayoneClearingData.clearing_txid}
	{/if}
{/if}
Example: PayPal Installments

PayPal Installments requires the merchant to display extra information about the installments in the mails and invoice. Here's how to do it:

{if $additional.payment.name == "mopt_payone__fin_paypal_installment"}
	{if $additional.moptPayoneClearingData}
		Finanzierungskosten: $additional.moptPayoneClearingDataclearing_total_interest_value|currency}
		Gesamtbetrag(mit Finanzierungskosten):{$additional.moptPayoneClearingData.clearing_total_cost_value|currency}
	{/if}
{/if} 

This block appends the installment amount and the grand total including installment cost into the mail.

Extending HTML Templates

Please search for the following block (the data can also be inserted elsewhere here):

Smarty
{if $additional.payment.name == "prepayment"}
	our bank details:<br/>
	{config name=bankAccount}
{/if}

and insert the following block:

{if $additional.payment.name == "mopt_payone__acc_payinadvance" or $additional.payment.name == "mopt_payone__acc_invoice" }
	{if $additional.moptPayoneClearingData}
		{if !empty($additional.moptPayoneClearingData.clearing_bankaccountholder)
		 or !empty($additional.moptPayoneClearingData.clearing_bankaccount)
 		or !empty($additional.moptPayoneClearingData.clearing_bankcode)
 		or !empty($additional.moptPayoneClearingData.clearing_bankiban)
		 or !empty($additional.moptPayoneClearingData.clearing_bankbic)
		 or !empty($additional.moptPayoneClearingData.clearing_bankname)
		}
			<strong>our bank details</strong><br/>
			{if !empty($additional.moptPayoneClearingData.clearing_bankaccountholder)}
				account holder: {$additional.moptPayoneClearingData.clearing_bankaccountholder}<br/>
			{/if}
			{if !empty($additional.moptPayoneClearingData.clearing_bankaccount)}
				bank account: {$additional.moptPayoneClearingData.clearing_bankaccount}<br/>
			{/if}
			{if !empty($additional.moptPayoneClearingData.clearing_bankcode)}
				bank code: {$additional.moptPayoneClearingData.clearing_bankcode}<br/>
			{/if}
			{if !empty($additional.moptPayoneClearingData.clearing_bankiban)}
				IBAN: {$additional.moptPayoneClearingData.clearing_bankiban}<br/>
			{/if}
			{if !empty($additional.moptPayoneClearingData.clearing_bankbic)}
				BIC: {$additional.moptPayoneClearingData.clearing_bankbic}<br/>
			{/if}
			{if !empty($additional.moptPayoneClearingData.clearing_bankname)}
				Bank: {$additional.moptPayoneClearingData.clearing_bankname}<br/>
			{/if}
			{if !empty($additional.moptPayoneClearingData.clearing_bankcountry)}
				bank country: {$additional.moptPayoneClearingData.clearing_bankcountry}<br/>
			{/if}
			{if !empty($additional.moptPayoneClearingData.clearing_txid)}
				reference: {$additional.moptPayoneClearingData.clearing_txid}<br/>
			{/if}
		{/if}
	{/if}
{/if}


If required, the remaining clearing data, such as the country, can also be displayed according to the following pattern:

{$additional.moptPayoneClearingData.clearing_bankcountry}

The names depend on the names of the PAYONE parameters. With the HTML variant, the output can still be designed with HTML and CSS and adapted to the corresponding layout.

Extending PDF Templates

To display the clearing data on PDF documents, the JSON-encoded content of the corresponding variable must first be decoded. This is done in the .tpl file for the invoice (or similar) for your template:

{assign var=mopt_payone_decoded_clearing_data value=$Order._order.attributes.mopt_payone_clearing_data|json_decode:true}

These variables, among others, are then available:

ContentVariable
Recipient
{$mopt_payone_decoded_clearing_data.clearing_bankaccountholder}

IBAN

{$mopt_payone_decoded_clearing_data.clearing_bankiban}
BIC
{$mopt_payone_decoded_clearing_data.clearing_bankbic}
Bank
{$mopt_payone_decoded_clearing_data.clearing_bankname}
Clearing Reference
{$mopt_payone_decoded_clearing_data.clearing_reference}
{$attributes.mopt_payone_txid}
{$sBookingID}
Invoice gross amount
{$Order._order.invoice_amount}
Invoice net amount
{$Order._order.invoice_amount_net}
List all variables (for debugging purposes)
{$mopt_payone_decoded_clearing_data|print_r}
PayPal Installments

PayPal Installments requires the merchant to display extra information about the installments in the mails and invoice. Here's how to do it:

Please find the invoice template in your shop directory. (standard for shopware 5: shoproot/themes/Frontend/Bare/documents/index.tpl). In the block {block name="document_index_amount"} this code has to be added:

{if $Order._payment.name == 'mopt_payone__fin_paypal_installment' }
 <tr>
 <td align="right"><b>Finanzierungskosten:</b></td>
 <td align="right"><b>{$mopt_payone_decoded_clearing_data.clearing_total_interest_value|currency}</b></td>
 </tr>
 <tr>
 <td align="right"><b>Gesamtbetrag(mit Finanzierungskosten):</b></td>
 <td align="right"><b>{$mopt_payone_decoded_clearing_data.clearing_total_cost_value|currency}</b></td>
 </tr>
 {/if

Risk Management

By installing the PAYONE Payment Plug-in for Shopware, the condition of the traffic light value has been added to the existing rules. At this point, you can determine whether a payment type is blocked using a defined traffic light value.

Shipping Costs

To ensure smooth operation of the plug-in, it is necessary to assign shipping rates to each payment method. As a further option, you can define an alternative shipping type that always takes effect if no concrete shipping cost record is assigned to a payment type.

Snippets

For the display of certain texts, text modules have been provided with the installation of the plug-in, which you can adapt according to the language used in each case. You find the administration of the snippets under Configuration > Snippets.

All text output (except bank names, e.g. with iDeal) in the frontend is provided via text modules, so that there is the greatest possible flexibility when using several languages. According to the Shopware standard, the text modules are initialized and stored in the database the first time they are used. They are then editable. The most important components are already stored during the installation of the plug-in. To edit specific text modules, you may first have to call the corresponding page in the frontend.

The text frame for the PAYONE plug-in can be found in the namespace frontend/MoptPaymentPayone. There is a general error message "generalErrorMessage" that is used when no specific error message is available. Specific error messages can be configured for individual error codes from the PAYONE platform. The text module for an error number 888 is then called "errorMessage888". Exceptions to this are the check of the bank details and the address, since no numerical error codes are returned there. The text modules for this are called "bankaccountcheck-blocked" or "addresscheckcorrected".

For technical reasons, only a few individual elements of the checkout can be processed directly in the templates. These templates can be found at:

/engine/Shopware/Plugins/Default/Frontend/MoptPaymentPayone/ViewsResponsive/frontend/plugins/payment 

in the Shopware directory. This applies in particular to the BillSAFE and eps payment methods.

Please ensure to always clear the shop caches after any alterations!


Using the plugin

Orders

Via the Orders menu, you can use the plug-in to initiate collections and create credit notes. To do this, you have to edit the respective order by clicking on the pen.
 
In the following order details, you will find new buttons in the Positions tab that trigger the collection of money or the crediting via a PAYONE payment method.

Collect Money

Individual items must be marked in order to retract them. After a click on the Positions retract button the following message appears.

 

Make sure that the amount is the same as the amount to be collected. Decide whether the shipping costs should also be collected. After a click on (partial) capture, the money is collected and the claim is booked on the PAYONE platform. For a partial withdrawal, simply add a new identical item to the item and specify the quantity of items you wish to withdraw. Make sure, however, that the original position is reduced in terms of quantity. Only in the case of an order conclusion with the payment method BillSAFE, which took place in partial deliveries, a final capture is necessary.

Create credit memos

The items to be credited must be marked in the same way as for money collection.

Check that the amount shown in red corresponds to the amount you want to credit. Decide whether the shipping costs should be credited. After clicking on Yes, a credit note will be generated on the PAYONE platform. As with money collection, you can create partial credit memos by creating new identical items with different item quantities.

Logs

Within the menu item PAYONE you will find all information about processed payments and communication with the PAYONE platform.

API log

The overview shows all incoming and processed requests to the PAYONE platform. By clicking on an entry you can view details of the respective request.

Transaction status log

As with API logs, you have an overview of received transaction status messages and can view details by clicking on a record.

Transactionstatus-Forwarding-Log

If errors occur during the forwarding of transaction status messages, these can be displayed in a separate system log and downloaded if necessary.

You activate logging in the "Transaction Status Forwarding" configuration area.

You can then view and download the current forwarding logs under Configuration → Logfile in the System Log tab:

Here's a list of what these entries mean and when they occur:

Protocol entrywhen?what does it mean?
notification controller calledalwaysinformational value only - marks the start of txstatus processing
different shop active, submitted id, new shopid [1,2,2]active shop has a different ID than the shop that's referred to in the request1,2,2 means:
  • active shop has ID 1
  • Request refers to shop ID 2
  • tx status processing therefore uses shop ID 2
push received for tx 123456789alwaystxid of txstatus request
clearingdata already existsif a transaction already has clearing data attached to itinfo - clearing data doesn't get overwritten
clearingdata is emptyif a transaction doesn't have yet clearing data attached to itinfo - clearing data from the txstatus request is attached to the transaction
save attribute dataalwaysinfo - data gets saved as attributes to an order
finished, output TSOKalwaysprocessing finished - TSOK is being sent
starting tx forwardsalwaysinfo - txstatus gets forwarded now
finished all tasks, exitalwaysinfo - end of txstatus forwarding

Help & Support

Do you have any bugs or suggestions to improve the code of the extension? Open an issue in our Github repo story: https://github.com/payone-gmbh
If you have any questions regarding the installation or use of the BS PAYONE Extension, please contact our Technical Support at the following contact details:

email

tech.support@bspayone.com

Phone

+49 431 259 68-500

Merchant Service

for billing and contract issues

email

merchantservice@bspayone.com

Phone

+49 431 259 68-200

Quick Facts

Download

Transactionstatus URL:

<SHOPURL>/MoptShopNotification

LATEST RELEASE     v4.1.0
 Click here for release details

New Features
  • Excluded express payment methods from addresschecks
  • Removed unnecessary query for cardholder in checkout
  • New config to allow Packstation usage for PayPal ECS
  • Amazon Pay is now PSD2 compatible


Bugfixes

  • Correct net flag when using redirect payment methods and/or Business Essentials
  • Many smaller changes


Maintenance

  • Added Compatibility for Shopware 5.6


  • No labels