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

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.

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

GiropaySofortEPSiDEALPostFinance

SEPAPrepaymentInvoiceCash on Delivery

PayPalPaydirektAmazon PayAlipay

PAYONE Secure InvoiceKlarnaPaysafe Pay Later

Barzahlen

Installation with Composer

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

Console
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 

You are invited to download or contribute to our plugin on 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 > TransactionStatus URL

https://www.example.com/payone/transactionstatus


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

Configuration

due to limitations introduced in Magento 2.3.1, all payment methods are active by default after the initial installation. Please make sure that you deactivate all payment methods you don't need before launch!

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.

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.

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.

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

Turn on IP collection during checkout under PAYONE → General --> Global

Submit cart items for credit card orders

Request the following info during checkout (on by default)

  • phone number
  • shipping address
  • complete billing address

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.

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

Request BICToggles whether the BIC is queried in the checkout. Use this configuration for better compatibility with bank accounts from outside DACH
Validate Bank Code

Toggles a verification of the bank details via "bankaccountcheck" request.

This request is part of our optional Risk Management Module

Bank Code Validation Type

Choose which validation type is used:

  • Regular - IBAN is checked for correct syntax
  • POS Blacklist - check against POS Blacklist to find out whether an IBAN is blacklisted by major Retailers
Message to display for blocked bank accountsThis 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

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

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.

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.

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.

In some cases there can be an interference between our plugin and the Amazon plugin provided in the Magento Core. So if you encounter "strange behavior" like disapperaing amazon buttons, you could try issuing the following command in the magento root:

php bin/magento module:disable Amazon_Payment

Protect

Simple Protect

Introduction

Simple Protect is the easy and flexible way of using all the data you have, right in the moment when your shop is proccessing the checkout. You can i.e. gain information from:

  • your magento 2 shop database
  • the current checkout session
  • external sources that can be reached and accessed from the shop server
    • datawarehouse
    • csv / xml / txt - files that can be accessed with PHP
    • APIs or extensions like the PAYONE Protect Functions
  • and many more.

Here is an example of some complex decisions that can be performed using our simple protect framework:


Simple Protect is currently under beta stage. If you want to use this functionality you have to download the PAYONE Integration from the Simple Protect branch:

After that, please follow the intructions for installing the Simple Protect Template here:

Please be aware that all functions described in the legacy part of this documentation won't be available anymore when using simple protect. For the time being, we also don't offer a migration mechanism.

Configuration

There is only one configuration option present in the backend from magento 2. The Protect-Mode. This can be found at:

Stores > PAYONE > General > Protect - Mode

Field

Description

Protect-Mode

There are to options available:

  • Test (default)
  • Live

This option only affects requests regarding the PAYONE - API like adresscheck or consumerscore. Any other code will be executed as developed.

Entry points / Points of action

The class app/code/Payone/SimpleProtect/Model/SimpleProtect/SimpleProtect.php is the central point to implement the decisions. The following methods reperesent the points where the actions are taking place.

Example of full implementation
<?php

/**
 * PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PAYONE Magento 2 Connector is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
 *
 * PHP version 5
 *
 * @category  Payone
 * @package   Payone_Magento2_SimpleProtect
 * @author    FATCHIP GmbH <support@fatchip.de>
 * @copyright 2003 - 2019 Payone GmbH
 * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
 * @link      http://www.payone.de
 */

namespace Payone\SimpleProtect\Model\SimpleProtect;

use Magento\Payment\Model\MethodInterface;
use Magento\Quote\Model\Quote;
use Payone\Core\Model\SimpleProtect\SimpleProtect as OrigSimpleProtect;
use Payone\Core\Model\PayoneConfig;
use Magento\Customer\Api\Data\CustomerInterface;
use Magento\Quote\Model\Quote\Address;
use Payone\Core\Model\Source\AddressCheckType;
use Payone\Core\Model\Source\CreditratingCheckType;
use Magento\Framework\Exception\LocalizedException;
use Payone\Core\Model\Exception\FilterMethodListException;
use Payone\Core\Model\Api\Response\AddresscheckResponse;
use Payone\Core\Model\Api\Response\ConsumerscoreResponse;
use Magento\Quote\Api\Data\AddressInterface;
use Magento\Store\Model\ScopeInterface;

class SimpleProtect extends OrigSimpleProtect
{
    const MODULE_VERSION = '1.0.0';

    /**
     * Whitelist of safe payment methods
     *
     * @var array
     */
    protected $safePaymentMethods = [
        PayoneConfig::METHOD_ADVANCE_PAYMENT,
        PayoneConfig::METHOD_CREDITCARD,
        PayoneConfig::METHOD_PAYPAL
    ];

    /**
     * PAYONE Protect model providing access to consumerscore and addresscheck requests
     *
     * @var \Payone\Core\Model\SimpleProtect\ProtectFunnel
     */
    protected $protectFunnel;

    /**
     * Database connection resource
     *
     * @var \Magento\Framework\App\ResourceConnection
     */
    protected $databaseResource;

    /**
     * Checkout session object
     *
     * @var \Magento\Checkout\Model\Session\Proxy
     */
    protected $checkoutSession;

    /**
     * Scope config object
     *
     * @var \Magento\Framework\App\Config\ScopeConfigInterface
     */
    protected $scopeConfig;

    /**
     * Constructor
     *
     * @param \Payone\Core\Model\SimpleProtect\ProtectFunnel     $protectFunnel
     * @param \Magento\Framework\App\ResourceConnection          $resource
     * @param \Magento\Checkout\Model\Session\Proxy              $checkoutSession
     * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
     */
    public function __construct(
        \Payone\Core\Model\SimpleProtect\ProtectFunnel $protectFunnel,
        \Magento\Framework\App\ResourceConnection $resource,
        \Magento\Checkout\Model\Session\Proxy $checkoutSession,
        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
    ) {
        parent::__construct($protectFunnel);
        $this->databaseResource = $resource;
        $this->checkoutSession = $checkoutSession;
        $this->scopeConfig = $scopeConfig;
    }

    /**
     * Returns configured operation mode used for the addresscheck and consumerscore
     *
     * @return string
     */
    public function getOperationMode()
    {
        return $this->scopeConfig->getValue('payone_general/global/protect_mode', ScopeInterface::SCOPE_STORES);
    }

    /**
     * Get count of customers orders
     *
     * @param CustomerInterface $oCustomer
     * @return int
     */
    protected function getCustomersOrderCount(CustomerInterface $oCustomer)
    {
        $db = $this->databaseResource->getConnection();
        $oSelect = $db->select()
            ->from($this->databaseResource->getTableName('sales_order'), ['COUNT(entity_id)'])
            ->where("customer_id = :customerId");
        $iCount = $db->fetchOne($oSelect, ['customerId' => $oCustomer->getId()]);
        if ($iCount === null) {
            return 0;
        }
        return $iCount;
    }

    /**
     * Check if the customer has ordered before
     *
     * @param CustomerInterface $oCustomer
     * @return bool
     */
    protected function isRecurringCustomer(CustomerInterface $oCustomer)
    {
        if ($this->getCustomersOrderCount($oCustomer) == 0) {
            return false;
        }
        return true;
    }

    /**
     * Possibility to whiteliste customers with custom functionality
     *
     * @param  CustomerInterface $oCustomer
     * @return bool
     */
    protected function isCustomerWhitelisted(CustomerInterface $oCustomer)
    {
        return true; // implement this for yourself or remove completely
    }

    /**
     * Generate hash of given address for comparison
     *
     * @param  Address $oAddress
     * @return string
     */
    protected function getAddressHash(Address $oAddress) {
        $sAddress  = $oAddress->getFirstname();
        $sAddress .= $oAddress->getLastname();
        $sAddress .= $oAddress->getCity();
        $sAddress .= $oAddress->getPostcode();
        $sAddress .= $oAddress->getCountry();
        $sAddress .= $oAddress->getStreetFull();

        return md5($sAddress);
    }

    /**
     * Compare given addresses, return true if they are the same
     *
     * @param  Address $oBilling
     * @param  Address $oShipping
     * @return bool
     */
    protected function isBillingAndShippingAddressTheSame(Address $oBilling, Address $oShipping)
    {
        if ($this->getAddressHash($oBilling) != $this->getAddressHash($oShipping)) {
            return false;
        }
        return true;
    }

    /**
     * Filter out all payment methods except for the safe payment methods
     *
     * @param  MethodInterface[] $aPaymentMethods
     * @return MethodInterface[]
     */
    protected function getSafePaymentMethods($aPaymentMethods)
    {
        $aReturn = [];
        foreach ($aPaymentMethods as $oPaymentMethod) {
            if (in_array($oPaymentMethod->getCode(), $this->safePaymentMethods) === true) {
                $aReturn[] = $oPaymentMethod;
            }
        }
        return $aReturn;
    }

    /**
     * Examples of all the options for addresscheck usage
     *
     * @param  Quote $oQuote
     * @return AddresscheckResponse|bool
     */
    protected function executeAddresscheck(Quote $oQuote)
    {
        $oAddress = $oQuote->getBillingAddress();
        #$oAddress = $oQuote->getShippingAddress();

        #$sAddresscheckType = AddressCheckType::NONE;
        $sAddresscheckType = AddressCheckType::BASIC;
        #$sAddresscheckType = AddressCheckType::PERSON;
        #$sAddresscheckType = AddressCheckType::BONIVERSUM_BASIC;
        #$sAddresscheckType = AddressCheckType::BONIVERSUM_PERSON;

        return $this->protectFunnel->executeAddresscheck($oAddress, $this->getOperationMode(), $sAddresscheckType, $this->getModuleVersion());
    }

    /**
     * Examples of all the options for consumerscore usage
     *
     * @param  Quote $oQuote
     * @return ConsumerscoreResponse|bool
     */
    protected function executeConsumerscore(Quote $oQuote)
    {
        $oAddress = $oQuote->getBillingAddress();
        #$oAddress = $oQuote->getShippingAddress();

        #$sConsumerscoreType = CreditratingCheckType::INFOSCORE_HARD;
        $sConsumerscoreType = CreditratingCheckType::INFOSCORE_ALL;
        #$sConsumerscoreType = CreditratingCheckType::INFOSCORE_ALL_BONI;
        #$sConsumerscoreType = CreditratingCheckType::BONIVERSUM_VERITA;

        $sAddresscheckType = AddressCheckType::NONE;
        #$sAddresscheckType = AddressCheckType::BASIC;
        #$sAddresscheckType = AddressCheckType::PERSON;
        #$sAddresscheckType = AddressCheckType::BONIVERSUM_BASIC;
        #$sAddresscheckType = AddressCheckType::BONIVERSUM_PERSON;

        return $this->protectFunnel->executeConsumerscore($oAddress, $this->getOperationMode(), $sConsumerscoreType, $sAddresscheckType, $this->getModuleVersion());
    }

    /**
     * Check rules for recurring registered customers
     *
     * @param  Quote $oQuote
     * @return bool
     */
    protected function isOnlySafePaymentApplicableForRecurringCustomer(Quote $oQuote)
    {
        if ($oQuote->getBaseGrandTotal() > 400 || $this->isCustomerWhitelisted($oQuote->getCustomer()) === false) {
            return true;
        }
        return false;
    }

    /**
     * Check rules for first time registered customer
     *
     * @param  Quote $oQuote
     * @param  bool  $blIsPrePaymentSelection
     * @return bool
     */
    protected function isOnlySafePaymentApplicableForInitialOrder(Quote $oQuote, $blIsPrePaymentSelection)
    {
        if ($blIsPrePaymentSelection === false && $this->isBillingAndShippingAddressTheSame($oQuote->getBillingAddress(), $oQuote->getShippingAddress()) === false) {
            return true;
        }

        if ($oQuote->getBaseGrandTotal() > 120) {
            return true;
        }

        if ($blIsPrePaymentSelection === false && !in_array($oQuote->getPayment()->getMethodInstance()->getCode(), $this->safePaymentMethods)) {
            $oResponse = $this->executeConsumerscore($oQuote);
            if ($oResponse instanceof ConsumerscoreResponse && ($oResponse->getStatus() != 'VALID' || $oResponse->getScore() != 'G')) {
                return true;
            }
        }
        return false;
    }

    /**
     * Check if only safe payment methods are applicable
     *
     * @param  Quote $oQuote
     * @param  bool  $blIsPrePaymentSelection
     * @return bool
     */
    protected function isOnlySafePaymentApplicable(Quote $oQuote, $blIsPrePaymentSelection)
    {
        if ($this->checkoutSession->getPayoneSimpleProtectOnlySafePaymentsAllowed() === true) {
            return true;
        }

        if ($oQuote->getCustomerId() === null) { // if guest checkout
            return true;
        }

        if ($this->isRecurringCustomer($oQuote->getCustomer()) === true) {
            return $this->isOnlySafePaymentApplicableForRecurringCustomer($oQuote);
        }
        return $this->isOnlySafePaymentApplicableForInitialOrder($oQuote, $blIsPrePaymentSelection);
    }

    /************************* MAIN SIMPLEPROTECT HOOKS *************************/

    /**
     * This method can be extended for individual custom behaviour
     *
     * Extending this method gives the following possibilities:
     * 1. Filtering out payment methods based on your own rule set
     * 2. Throwing a LocalizedException to send the user back to shipping method selection
     *
     * @param  Quote             $oQuote
     * @param  MethodInterface[] $aPaymentMethods
     * @return MethodInterface[]
     */
    public function handlePrePaymentSelection(Quote $oQuote, $aPaymentMethods)
    {
        if ($this->isOnlySafePaymentApplicable($oQuote, true) === true) {
            return $this->getSafePaymentMethods($aPaymentMethods);
        }
        return $aPaymentMethods;
    }

    /**
     * This method can be extended for individual custom behaviour
     *
     * Extending this method gives the following possibilities:
     * 1. Throwing a LocalizedException will stop the order creation and throw the user back to payment selection with the given thrown message
     * 2. Throwing a FilterMethodListException with an array of safe payment methods will stop the order creation and
     *    throw the user back to payment selection with the given thrown message and remove all other payment methods except for the given ones
     * 3. Finishing the method - so throwing no Exception will finish the order creation
     *
     * @param  Quote $oQuote
     * @return void
     * @throws LocalizedException
     * @throws FilterMethodListException
     */
    public function handlePostPaymentSelection(Quote $oQuote)
    {
        if ($this->isOnlySafePaymentApplicable($oQuote, false) === true) {
            $sMethodCode = $oQuote->getPayment()->getMethodInstance()->getCode();
            if (!in_array($sMethodCode, $this->safePaymentMethods)) {
                $this->checkoutSession->setPayoneSimpleProtectOnlySafePaymentsAllowed(true);
                throw new FilterMethodListException(__('Please select another payment method.'), $this->safePaymentMethods);
            }
        }
    }

    /**
     * This method can be extended to transfer the version of your Simple-Protect implementation to Payone
     * It is recommended to transfer the name of your module and the version, otherwise Payone doesn't know that it is a Simple-Protect call
     *
     * @return string|null
     */
    public function getModuleVersion()
    {
        return 'Payone_SimpleProtect-'.self::MODULE_VERSION;
    }
}


We're curating more samples at Magento 2 - Simple Protect. Here you will find more information on how to gain data for your decisions. You're also invited to add more examples as issues on github or vial email at docs@payone.com

handlePrePaymentSelection

Implementing this method gives you the following possibilities:

  1. Throwing a LocalizedException will stop the order creation and throw the user back to payment selection with the given thrown message
  2. Throwing a FilterMethodListException with an array of safe payment methods will stop the order creation and throw the user back to payment selection with the given thrown message and remove all other payment methods except for the given ones
  3. Finishing the method - so throwing no Exception will finish the order creation
@param  Quote $oQuote
@param  MethodInterface[] $aPaymentMethods
@return MethodInterface[]

public function handlePrePaymentSelection(Quote $oQuote, $aPaymentMethods)
{
    if ($this->isOnlySafePaymentApplicable($oQuote, true) === true) {
        return $this->getSafePaymentMethods($aPaymentMethods);
    }
    return $aPaymentMethods;
}
handlePostPaymentSelection

Implementing this method gives you the following possibilities:

  1. Throwing a LocalizedException will stop the order creation and throw the user back to payment selection with the given thrown message
  2. Throwing a FilterMethodListException with an array of safe payment methods will stop the order creation and throw the user back to payment selection with the given thrown message and remove all other payment methods except for the given ones
  3. Finishing the method - so throwing no Exception will finish the order creation
@param  Quote $oQuote
@return void
@throws LocalizedException
@throws FilterMethodListException

public function handlePostPaymentSelection(Quote $oQuote)
{
    if ($this->isOnlySafePaymentApplicable($oQuote, false) === true) {
        $sMethodCode = $oQuote->getPayment()->getMethodInstance()->getCode();
        if (!in_array($sMethodCode, $this->safePaymentMethods)) {
            $this->checkoutSession->setPayoneSimpleProtectOnlySafePaymentsAllowed(true);
            throw new FilterMethodListException(__('Please select another payment method.'), $this->safePaymentMethods);
        }
    }
}
handleEnterOrChangeBillingAddress

Implementing this method gives you the following possibilities:

  1. Returning true will just continue the process without changing anything
  2. Returning a (changed) address object instance of AddressInterface will show an address correction prompt to the customer
  3. Throwing a LocalizedException will show the given exception message to the customer
@param AddressInterface $oAddressData
@param bool $blIsVirtual
@param double $dTotal
@return AddressInterface|bool
@throws LocalizedException

public function handleEnterOrChangeBillingAddress(AddressInterface $oAddressData, $blIsVirtual, $dTotal)
    {
        $response = $this->protectFunnel->executeAddresscheck($oAddressData, $this->getOperationMode(), AddressCheckType::BASIC);
        if ($oAddressData->getCity() == "FalscheStadt") {
            $oAddressData->setCity($response->getCity());
            return $oAddressData;
        }
        return true;
    }
handleEnterOrChangeShippingAddress

Implementing this method gives you the following possibilities:

  1. Returning true will just continue the process without changing anything
  2. Returning a (changed) address object instance of AddressInterface will show an address correction prompt to the customer
  3. Throwing a LocalizedException will show the given exception message to the customer
@param AddressInterface $oAddressData
@param bool $blIsVirtual
@param double $dTotal
@return AddressInterface|bool
@throws LocalizedException

public function handleEnterOrChangeShippingAddress(AddressInterface $oAddressData, $blIsVirtual, $dTotal)
    {
        $response = $this->protectFunnel->executeAddresscheck($oAddressData, $this->getOperationMode(), AddressCheckType::BASIC);
        if ($oAddressData->getCity() == "FalscheStadt") {
            $oAddressData->setCity($response->getCity());
            return $oAddressData;
        }
        return true;
    }

Protect (Legacy)

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

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.

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.

Quick Facts

Download

Transactionstatus URL:

<SHOPURL>/index.php/payone/transactionstatus

LATEST RELEASE     v2.7.0
 Click here for release details

New Features

  • Amazon Pay is now PSD2 compatible

  • Decoupled txstatus forwarding from internal processing so a failed forward doesn't break the whole process

  • added webrestrictions.xml to avoid transaction-updates being blocked by website-restrictions

Bugfixes

  • better performance for address checks

  • more robust Amazon Pay button when official Amazon Plugin is also installed (but not active)

Maintenance

  • Compatibility with Magento 2.3.2

  • No labels