Versions Compared

Key

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

General Information

The PAYONE Payment-Extension for Magento 2.0 enables the connection of Magento version 2.0.0 and higher to the PAYONE platform for secure and automated handling of all payment processes.
The extension fits seamlessly into the existing checkout process of the Magento shop.
In the Magento administration area, extensive configuration and administration options are available. All functions of the extension can be configured individually and according to requirements.
The PAYONE Payment-Extension is developed in close cooperation with the agency FATCHIP GmbH and can be downloaded free of charge by interested merchants.
The extension is constantly being further developed.
Further information can be found at https://www.payone.com/magento and http://www.payone.com .

Functional Description

Supported Payment Methods

The extension supports the processing of the following payment methods via the PAYONE platform.

UI Tabs


UI Tab
titlecredit and debit cards


VisaMastercardMaestroAmerican ExpressJCBDiners ClubDiscover


UI Text Box
typeinfo
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.



UI Tab
titleSecurity Procedure


Verified by VisaMasterCard SecureCodeAmerican Express SafeKey



UI Tab
titleOnline Bank Transfer


GiropaySofortEPSiDEALPostFinance



UI Tab
titleWire Transfer


SEPAPrepaymentInvoiceCash on Delivery



UI Tab
titleWallets


PayPalPaydirektAmazon PayAlipay



UI Tab
titleSecured Payment Methods (factoring)


PAYONE Secure InvoiceKlarnaPaysafe Pay Later



UI Tab
titleCash


Barzahlen



Installation with Composer

Go to the root directory of your Magento 2 installation and execute the following commands.

Code Block
languagebash
titleConsole
linenumberstrue
composer require payone-gmbh/magento-2 
php bin/magento setup:upgrade 
php bin/magento setup:di:compile 
php bin/magento cache:clean

Code on Github 
Awesome Icon
size40px
iconfa-github

You are invited to download or contribute to our plugin on github!

Githubdownload
Repohttps://github.com/PAYONE-GmbH/magento-2/releases
Orientationcenter

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
typeinfo
https://www.example.com/payone/transactionstatus

Image RemovedImage Added


UI Text Box
typetip

please leave the hash calculation method on md5 to ensure correct communication between the PAYONE platform and magento

Configuration

General Information

Global


Field

Description

Merchant ID

The customer number assigned by PAYONE.

portal ID

The ID of the payment portal via which the shop sends its requests to the PAYONE platform.

sub account ID

The ID of the sub-account you created in the PMI through which the transactions are processed.

security key

The key you assign in the PMI to encrypt requests to the PAYONE platform.

Reference number prefix

Prefix for the reference parameter transmitted to PAYONE. This serves to avoid overlapping of different systems / installations.
In the parameter reference the Magento order number including this value is transmitted to PAYONE. If this value is not set, only the Magento order number will be transmitted.

Payment from Applicable Countries

Selection option for the shop in which countries payment via PAYONE is to be made possible.

authorize method

Indicates whether the payment type is addressed by "authorization" or "preauthorization".

  • Authorization - Here the payment method is debited directly when ordering (where possible) and a claim is written on the BS PAYONE platform.
  • Preauthorization - As far as possible, payment will be reserved at the time of order. The payment has to be collected later in the order.

UI Text Box
typeinfo

Please note
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.

In the case of online transfers (immediate transfer, giropay, etc.), the cash flow takes place directly, irrespective of the time of booking the receivable.


Transmit IP address

Select whether the IP address of the end customer should be transmitted to the PAYONE platform.

Data for Global Configuration


The parameters Merchant ID, Portal ID, Key and Subaccount ID are mandatory to operate the plugin.

UI Text Box
typetip

Do you not have access to the PMI yet? Request your test account here: https://www.bspayone.com/DE/de/channel/online

Send invoice information


Field

Description

Transmit invoice information

Select Yes / No. This option activates the transmission of article data in order to create an invoice on the PAYONE platform.

Dynamic invoice message

Free text entry for a dynamic text on the invoice. The maximum length is 255 characters and various Magento variables can be used as placeholders.

Dynamic refund message

Free text entry for a dynamic text on the credit memo. The maximum length is 255 characters and various Magento variables can be used as placeholders.

Status Mapping



In this mask the different transaction statuses of the PAYONE platform can be mapped to Magento order status. If a new transaction status is received, the corresponding "Magento status" is set in the order overview in the Magento backend.

Credit Card Payment

User-defined display for the hosted iframe



Field

Description

type

Selection of:

  • Numeric- Only numbers are allowed and for mobile devices the numeric keyboard is used input type="tel".
  • Password - input type="password"
  • Text - input type="text"

digit count

Length of the field in characters ( HTML attribute size )

max digits

Maximum length of input ( HTML attribute maxlength )

iFrame

Selection of:

  • Standard - Uses width and height from standard style
  • Custom - Uses width and height from the following fields

width

CSS - Specify width

Height

CSS - Indication of height

style

  • Standard - Uses CSS specification from Standard
  • Custom- Uses CSS specification from the following field

CSS

Specification of CSS properties for field
Deactivated with previous selection of Standard

Standard styles

  • Input - CSS specification for all input fields (HTML input)
  • Selection - CSS specification for all selection fields (HTML select )

iFrame

  • Width - CSS specification
  • Height - CSS specification

error output

 

active

checkbox

language

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

Preview

At this point you can see how the appearance looks like according to the previous setting of the payment method credit card in the checkout.

Payment Methods

Edit Payment Method


Field

Description

Enabled

Select Yes / No if the payment method is activated.

title

Free text entry for the name of the payment method as it is displayed to the customer in the checkout.

New Order Status

Status the Magento order will have after use of this payment method.

instructions

Free text input for the display of additional information on the payment type in the checkout.

Minimum Order Total

The minimum value of goods from which the payment type is displayed to the customer in the checkout.

Maximum Order Total

The maximum value of goods up to which the payment method is displayed to the customer in the checkout. Please note that here, in contrast to the configuration of the credit check, the Magento internal value "BaseGrandTotal" (i.e. the completely invoiced amount including VAT and shipping costs) is used as a basis.

Sort Order

Enter an integer that determines where in the checkout the payment method is offered to the customer.

fashion

Choice between Test / Live. This determines whether the PAYONE platform is addressed in Test or Live mode.

Use Global Settings

Select Yes / No. If No is selected, all parameters from the global settings can be configured individually for this payment method.

Payment Type-Specific Settings

The following describes the configuration options that are specific to a payment type. Only those fields are explained that differ from the above configuration or are new.

Credit Card



Field

Description

type of credit card

Multiple selection. Which credit card brands should be offered in the frontend?

Check Card Validation Code

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

UI Text Box
typeinfo

From a purely technical point of view, querying the CVC is optional. However, most end customers are used to the query.


SEPA Basic Direct Debit Scheme

Field

Description

Message to display for blocked bank accounts

This message is displayed in the checkout if the bank details check returns a negative result.

List of supported SEPA countries

Multiple selection of the countries from which the payment type debit memo is supported. The PAYONE platform currently only supports direct debits for German bank accounts.

Mandates enabled

Select Yes / No. Should the SEPA mandate manager be used? A check of the bank details is obligatory. A check against the POS lock list is not possible.

Mandates download enabled

Select Yes / No. If Yes is selected, a link is offered after the order has been placed, via which the end customer can download the SEPA Mandate as a PDF file.

PayPal



Field

Description

PayPal Express enabled

Activation of the PayPal Express button in the shopping cart display

Amazon Pay

UI Steps


UI Step

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


UI Step

Retrieve Configuration in Magento Backend

To activate the payment method, please use the "get configuration" button. This retrieves your client ID and Seller ID from our Platform. You should then see the values in the corresponding fields.


UI Step

Activate the Payment Method

Please note that you can only make live payments after the payment method is allowed for live payments in Seller Central


FieldDescriptionExample
Amazon Client IDDisplays the current Client ID
Amazon Seller IDDisplays the current Seller ID
Get configuration

click this button to retrieve the current configuration from PAYONE.

UI Text Box
typewarning

This payment method won't work before the configuration has been saved!




Amazon Button Type

Selection of

  • Amazon Pay (normal) 
  • Pay (smaller)
  • Amazon Pay (smallest)

Amazon Button Color

Selection of

  • Gold
  • Light grey
  • Dark grey

 

Amazon Mode

Selection of

  • Automatic (uses the client's default language)
  • English
  • German
  • French
  • Italian
  • Spanish

Amazon Mode

Selection of

  • Always Synchronous
  • Asynchronous on failure
async on failure can have better conversion rate, but can complicate your workflow.

Protect

Address Validation

Field

Description

Enabled

Activating the address check

Mode

Choice between Test / Live. This determines whether the PAYONE platform is addressed in Test or Live mode.

Check Billing Address

Configuration with which check the invoice address is to be checked.

Check Shipping Address

Configuration with which check the delivery address is to be checked.

Check Billing Address fpr virtual orders

Select yes/no whether the billing address should be checked for virtual orders.

Confirm address correction

Selection yes/no whether an address correction must be confirmed by the buyer

Person Status Mapping

Assignment of individual person status returns to a traffic light value

UI Text Box

Works only with the address check "Person", which returns personal information


Message to display for invalid data

Error message to be displayed at status "INVALID"

Response ERROR handling

What should be executed after an error in the extension or the PAYONE platform?

Minimum Order Total

Minimum amount to execute an address check.

Maximum Order Total

Maximum amount to execute an address check.

lifetime

Number of days in which no new address validation is performed.

Credit Assessment

Field

Description

Enabled

Activation of the credit rating check

Mode

Choice between Test / Live. This determines whether the PAYONE platform is addressed in Test or Live mode.

Integration Event

Selection of "Before/After" payment selection.

Credit rating check type

Selection of:

  • info score
    • hard criteria
    • all criteria
    • all criteria with boniscore
  • bon universe
    • verita score

Default values for unknown scores

Selection of a traffic light color for the return status "Unknown

only affects Boniversum verita score!

Confirm address correction

Selection yes/no whether an address correction must be confirmed by the buyer

Allowed Payment Method for "YELLOW/RED"

Multiple selection of the permitted payment type according to traffic light color

Sample Mode enabled

Selection of Yes/no and subsequent input for verification of each nth address.

Insufficient score error message

Message that is displayed to the customer when an insufficient score value is reached.

Response ERROR handling

What to do after an error in the integration or the PAYONE platform.

Minimum Order Total

Minimum amount to carry out a credit check.

Maximum Order Total

Maximum amount to carry out a credit check.

lifetime

Number of days in which no new address validation is performed.


UI Text Box
typeinfo

Service provider for address checks
Various service providers are available for address and creditworthiness checks. Our support team will be happy to explain the range of services of the individual checks and which service provider is the right one for you.

Other

Processing the Transaction Status


Field

Description

Valid PAYONE IPs

List of valid PAYONE IP addresses that may deliver a transaction status.
 After the installation, the currently valid IP addresses are specified there. Only change if necessary. You only need to add these addresses if your system landscape works with load balancers or proxy systems, for example. Please consult your admin or hosting service provider.

Forwarding the Transaction Status


Field

Description

forwarding

At this point you can define which status is forwarded to which URL and how long the timeout is in seconds until the redirection attempt is terminated.

Invoice information - Discount

Field

Description

SKU

Here you can define a SKU that shall be used to identify discount items. This can be left blank unless you are experiencing issues with shopping cart items

Invoice information - Shipping costs

Field

Description

SKU

Here you can define a SKU that shall be used to identify shipping items. This can be left blank unless you are experiencing issues with shopping cart items

Invoice Information - Credit Memo


Field

Description

SKU

Here you can define a SKU that shall be used to identify vouchers. This can be left blank unless you are experiencing issues with shopping cart items

Export configuration


A click on Export Configuration opens a download request of your browser.

You can now open this file with an XML editor and view or save it. This export is very important for every support request to the PAYONE team in order to avoid possible configuration problems. This file can also be used to determine whether any further extensions have been installed that could cause compatibility problems.

Orders

Overview




Here you will find a PAYONE-specific order overview similar to the Magento order overview. In addition to the standard information, you can view the payment status on the PAYONE platform, the exact type of payment (e.g. credit card brands) and, if applicable, the dunning status. A click on View opens the detailed view of the corresponding order.

Logs

Under the menu item Logs you'll find all information about processed payments and communication with the PAYONE platform.

Transactionstatus

Overview


The Transactions submenu item displays Magento received transaction status notifications for each order and transaction. These notifications are sent from the PAYONE platform to your shop. If there are any errors, you can find out here whether the transaction status was received correctly and what the current status is for a transaction. By clicking on View, you can display details on a transaction status.

Details


On the details page, you will see all the transaction status information transmitted through the PAYONE platform to your shop. Thus, you can always track which data your Magento shop has received and processed.
A detailed explanation of the respective parameters can be found in the technical documentation of the PAYONE platform in the PAYONE Merchant Interface (PMI) under Downloads > Documentation.

API

Overview


In this overview you will find all requests from the Magento shop to the PAYONE platform as well as the answers of the PAYONE platform to these requests. Only the requests that were transmitted to the PAYONE platform via Client API are not listed in this overview. This applies to credit card information that is transferred directly from the buyer's browser to the PAYONE platform using Ajax technology so that your shop does not come into contact with sensitive credit card information. By clicking on View, you can display an API request in detail.

Details


In the left column you can see the request that the Magento shop has sent to the PAYONE platform. On the right you will find the answer. A detailed explanation of the respective parameters can be found in the technical documentation of the PAYONE platform in the PAYONE Merchant Interface (PMI) under Downloads > Documentation.

Information and Support

Do you have any bugs or suggestions to improve the code of the extension? Open an issue in our Github repository: 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:

technical support

for technical questions

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

Please note that PAYONE provides the extension for Magento free of charge and the free support of BS PAYONE therefore only contains general questions about the extension as well as the support for the BS PAYONE platform. For detailed questions, we recommend that you contact your Magento partner directly.

Image Added

Integrationquickfacts
TXURLindex.php/payone/transactionstatus
Repohttps://github.com/PAYONE-GmbH/magento-2/releases
Version2.5.0
Systemmagento2

Table of Contents
outlinetrue
indent2em