General Information

The PAYONE Payment-Extension for OXID eShops enables the connection of OXID eShops of version series 4 to the PAYONE platform for the secure and automated handling of all payment processes.

The extension supports more than 20 national and international payment methods and offers integrated risk management services to minimise the risk of non-payment. The payment type portfolio can be dynamically controlled depending on the creditworthiness of the respective buyer.
The extension fits seamlessly into the existing checkout process of the OXID eShop.

In the OXID 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 for OXID eShops was developed in close cooperation with the OXID Certified Premium Solution Partner FATCHIP GmbH and is available to interested merchants for free download.

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 PayMasterPass




PAYONE Secure InvoiceKlarnaRatePayPaysafe Pay Later




Barzahlen



Risk Management

The following risk management services are supported by the extension:


Address Check Basic (20 countries [1] )

  • 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 type portfolio

The PAYONE Payment-Extension for OXID eShops allows you to control which payment methods should be 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 extension fits seamlessly into the existing checkout process of the OXID eShop. Communication and data transfer takes place in the background - not visible to the buyer - between the extension 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 at PAYONE via the Client API of the PAYONE platform. Furthermore, it is possible to use the credit card payment method via the front end, which is addressed via an iFrame.

Feedback about the status of the processed transactions is given via the transaction status of the PAYONE platform, which is processed by the extension to synchronize orders in the OXID eShop with the current status.

Logging

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

  • risk management services
  • Payment processing (via Server API)
  • 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 administration options of the extension

The extension provides a new menu item PAYONE in the OXID administration area of your OXID eShop. All configuration and management options as well as protocols, logs and information are centrally located in this.

Subshops

Subshops of the OXID eShop are fully supported. When using subshops, the configuration settings must be made for each subshop. This enables differentiated configuration options for the shop with regard to payment processing and risk management.

Download & Installation

PAYONE has developed with Fatchip GmbH as OXID Certified Premium Solution Partner a special installation offer for PAYONE dealers.

Compatibility and Requirements

PAYONE Payment-Extension:

  • up to OXID eShop version 4.5 Extension version 1.1.5
  • from OXID eShop version 4.5 Extension version > 1.3.x

OXID eShop:

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

PAYONE merchant account:

  • PAYONE Processing or Business
    • Server API
    • Client API (if credit or debit cards are to be processed)
  • Types of payment according to your needs
  • Optional: Protect module (if risk management is to be used)
  • Optional: Further PAYONE modules (Invoicing, Collect)

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

The PAYONE Payment-Extension is available for free download via OXID eXchange and Github.





Installation Steps

Please perform the following steps to install the extension:


Make a backup of your system or your OXID eShop and your database and unpack the package.


Copy the contents of the copy_this folder into the root directory of your OXID eShop (where the config.inc.php is located).


Transfer the contents of the changed_full folder to the shop. If you are using an OXID eShop version smaller than 4.7, copy the respective directory; e.g. changed_full_42


If you are using an OXID eShop version older than 4.6.0 (which you shouldn't), set the following module entries in the administration interface under Admin > Master data > Basic settings > System > Modules

oxorder => fcPayOne/core/fcPayOneOrder 
oxpayment => fcPayOne/core/fcPayOnePayment 
oxpaymentgateway => fcPayOne/core/fcPayOnePaymentgateway
oxuser => fcPayOne/core/fcPayOneUser 
payment => fcPayOne/views/fcPayOnePaymentView
roles_bemain => fcPayOne/admin/fcPayOneRolesBeMain

Note: If one of the overwritten classes is already overwritten by another module, then you have to append the PAYONE payment extension with the & character (e.g.: oxorder => your/module/order& fcPayOne/core/fcPayOneOrder)

If you are using a newer version 4.6.0 or higher, go to the Extensions> Modules menu and select the Activate PAYONE Extension button to activate it.


Transactionstatus URL

The PAYONE Merchant Interface must be set to : Configuration > Payment Portals > IHR_PORTAL > Enhanced > TransactionStatus URL as confirmation address for the following URL:

https://yourshop.com/modules/fcPayOne/status.php


Please empty the tmp directory.


Configuration

After successful completion of the installation steps described in the previous chapter, the PAYONE main menu item is available in the administration area of your OXID eShop.

Payment Methods

In the menu item Configuration > Payment methods both the standard payment methods of your OXID eShop and the payment methods available via PAYONE are displayed. Here you can configure the desired payment methods.

The PAYONE payment types are an extension of the OXID standard payment types and offer additional options.
To display only the PAYONE payment types, use the filter function PAYONE Only in the header of the payment type table.

Overview

The overview shows you all PAYONE payment methods that are available for configuration. Please only configure the payment methods that have been activated for your merchant account.

Basic Configuration

You can recognize all PAYONE payment methods by the displayed logo.

Field

Description

authorization method

  • Pre-authorization Whenselecting "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 to be paid is collected immediately when the order is placed. The receivable is immediately booked on the PAYONE platform.

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 receivable is to be booked separately by "Capture" despite this.


PAYONE 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". For the payment methods credit card and online bank transfer the test mode has to be configured under the menu PAYONE > Configuration > Payment settings.
Note: Please note that the defined test data must be used for the test mode.

active

You use this checkbox to make the payment type available in the checkout process.

name

Here you can change the name of the payment type.
Note: The name entered here appears in the same wording in the checkout process.

Price premium/discount

Here you can set a price premium/discount for the payment type. The prices can be indicated in two different ways:

  • abs" indicates the absolute price (e.g. if you enter 7.50, 7.50 euros will be charged).
  • %" calculates the price relative to the shopping basket value. (For example, if you enter 2, 2 percent of the shopping basket value will be calculated). You can also enter negative values. This subtracts the entered value. (e.g. if you enter -2 and select %, 2% of the shopping basket value will be deducted.)

From credit rating index

Here you can specify that certain payment types are only available to users/buyers who have at least the defined creditworthiness index. You can enter the credit rating index for each user under the menu item Manage User > User > Advanced.
Note: If you have ordered the Protect module from PAYONE, you can automatically deposit this value with the respective user / buyer using the credit check.


Note: Settings for payment types without the PAYONE indicator have no effect on processing via PAYONE.

Subconfiguration of Payments

The global configuration settings for communication with the PAYONE platform are made under the menu item PAYONE > Configuration > PAYONE Payment Settings.


Connection Settings


Field

Description

PAYONE Merchant ID

You will find your PAYONE Merchant ID at the top right of the PAYONE Merchant Interface (PMI) and on all PAYONE invoices.

PAYONE 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.

PAYONE Portal Key

Please enter the key here to protect the data communication against manipulation. This must be identical to the key stored in the associated payment portal.

The configuration can be found in the PAYONE Merchant Interface (PMI) under the menu item Configuration > Payment Portals > [Edit] > Tab [Advanced] > Key


PAYONE 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

Reference number Prefix

Here you can configure how the reference number is supplemented to ensure uniqueness for the transfer to PAYONE. Note: This setting is required, for example, if you are running the extension on a test system and a production system.


An overview of the parameters to be configured for the connection settings such as Merchant ID or Portal ID can be found in the PAYONE Merchant Interface (PMI) under the following menu item Configuration > Payment Portals > [edit] > API Parameters tab

General information


Field

Description

Send article list

Here you can configure that the article information is also transferred to PAYONE.
Note: This option only needs to be activated if you have booked the Invoicing module with PAYONE.

Save order before authorization

Here you can define whether the order is already saved before the payment confirmation. These orders are then in a wait status.

Active Credit Card Brands Configuration

The credit card payment method in the extension is divided into various subtypes (card brands). These are currently:

  • Visa
  • master card
  • American Express
  • Diners Club
  • JCB
  • Maestro International
  • Maestro UK
  • Discover
  • Carte Bleue

You can activate or deactivate the respective card type in the overview. You also have the option of assigning countries from which you wish to accept the card to the respective card brand. In addition, you can set for each credit card brand whether it is activated in live or test mode.

Please note that local card brands should only be assigned for the respective country (e.g. Carte Bleue = France). In addition, the respective card brand must have been ordered and activated for your merchant account.

Credit Card Configuration



Field

Description

query type

Selection of:

  • hosted-iFrame
  • 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.


The following fields are only visible when hosted-iFrame is selected, because the settings are not applicable to the AJAX type.

 The Oxid Extension offers you the 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 configuration

Here you can set separate parameters for the individual fields of the credit card query.

type

Selection of:

  1. Numeric (number field which on mobile devices calls the number keystroke)
  2. password
  3. text
  4. Selection (drop-down list)

Number of characters

Width in number of characters for the field.

Max character

Maximum number of characters allowed for the field

IFrame

Selection of:

  1. Standard (uses the standard style)
  2. User-defined (uses the following input parameters)

width

Specification of width with CSS units

height

Height indication with CSS units

style

Selection of:

  • Standard (uses the standard style)
  • User-defined (uses the following input parameter)

CSS

Input of CSS.

The use of the attribute "url" leads to a non-display of the field


standard style

 

fields

Input fields for CSS for the field forms:

  • input
  • Selection (Drop-Down)

iframe

Input fields for width and height of iFrame in CSS

error output

 

active

Enables error output in checkout related to credit card entries.

Language

Selection of the display language for the error messages.

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 (on by default)

  • phone number
  • shipping address
  • complete billing address


Active Online Transfer Types Configuration

The payment method online bank transfer is divided into different subtypes (online bank transfer types) in the extension. These are current:

  • SOFORT
  • giropay
  • eps (electronic payment standard)
  • PostFinance E-finance
  • PostFinance Card
  • iDEAL

You can activate or deactivate the respective online transfer type in the overview. You also have the option of assigning valid countries to the respective online transfer type. In addition, you can specify for each online transfer type whether it is activated in Live or Test mode.


Please note that the respective online transfer type should be assigned to the relevant country (giropay - Germany, eps - Austria, PostFinance E-Finance & PostFinance Card - Switzerland, iDEAL - Netherlands). SOFORT bank transfer can be used for several countries. In addition, the respective online transfer method for your merchant account must have been ordered and activated.

SEPA Direct Debit

In the direct debit area, you can make settings with regard to the SEPA procedure (Single European Payments Area).


Field

Description

countries

Selection of countries for which direct debit may be offered.

Account number Display bank sort code

For German accounts, it is still possible to display the account number and bank sort code in addition to the IBAN / BIC. With this selection you activate the display.

Active mandate allocation

Activates the mandate management of PAYONE.

Download mandate as PDF

Here you can define whether the buyer receives a download of the mandate from PAYONE at the end of the checkout.

Klarna Store IDs

Field

Description

StoreIDs

Enter the StoreID(s) you received from Klarna here. This is / is needed to get to the right information pages during checkout. Please pay attention at this point to the correct country assignment for which a respective StoreID is valid.
Please note that for payment processing via Klarna the delivery address and the billing address must be identical.

Klarna Campaigns

You can add a Klarna purchase campaign via the button "Add another campaign".

Field

Description

campaign 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.

Please note that for payment processing via Klarna the delivery address and the billing address must be identical.


title

Here you can assign a name for this campaign.

countries

Assign a campaign to a country here. You can make the assignment using drag and drop.

Language

Here you can select the language for which this campaign is valid.

currency

Here you can select the currency for which this campaign is valid.

PayPal


Field

Description

In case of missing delivery address, the billing address will be handed over as delivery address.

If no explicit delivery address or a different delivery address has been specified, the billing address will be transmitted as the delivery address for the payment method PayPal - if the checkbox is activated.

active

Activates the entry

Language

Language to which this entry applies. Only languages created in the OXID eShop are displayed.

logo

Preview of the uploaded logo, which will be used later in the checkout.

upload

At this point the logo can be selected.

Standard

If activated, the entry or logo of this entry will be the default for all languages where no logo is available.

Barzahlen

To activate the payment method, we recommend that you copy the display at: https://integration.barzahlen.de/de/designanforderungen
Example:

<label for="payment_barzahlen">
  <img style="height: 3em; vertical-align: -1em;" src="https://cdn.barzahlen.de/images/barzahlen_logo.png" alt="Barzahlen">
</label>
<img style="float: right; margin-left: 10px; max-width: 180px; max-height: 180px;" src="https://cdn.barzahlen.de/images/barzahlen_special.png">
Mit Abschluss der Bestellung bekommen Sie einen Zahlschein angezeigt, den Sie sich ausdrucken oder auf Ihr Handy schicken lassen können. Bezahlen Sie den Online-Einkauf mit Hilfe des Zahlscheins an der Kasse einer Barzahlen-Partnerfiliale.<br/><br/>
<strong>Bezahlen Sie bei:</strong>
 
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_01.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_02.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_03.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_04.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_05.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_06.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_07.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_08.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_09.png" style="height: 1em; vertical-align: -0.1em;">
<img src="https://cdn.barzahlen.de/images/barzahlen_partner_10.png" style="height: 1em; vertical-align: -0.1em;">

Paysafe Pay later

Field

Description

Operate Payolution in B2B mode

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

company's name

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

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.

RatePay

For Ratepay Safe Invoice to work, please add your profile ID and provide the corresponding currency.

When B2B mode is activated and the company name specified by the user, the VAT ID no. is requested. For B2C customers the date of birth is requested instead.

Amazon Pay

FieldDescriptionExample
Amazon Seller IDDisplays the current Seller ID
Amazon Client IDDisplays the current Client ID
Retrieve configuration from PAYONE

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 (standard) 
  • Pay (slightly smaller)
  • Amazon Pay (super small)

Amazon Button Color

Selection of

  • Gold
  • Light grey
  • Dark grey

 

Amazon Mode

Selection of

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

Selection of

  • Automatic
  • Popup
  • Redirect
"Popup" only works for SSL-secured Shops (which you should have anyway!) In most cases it's best to leave this option on "automatic"


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>/index.php?cl=user&fnc=fcpoamazonloginreturn


Protect

Under the menu item PAYONE > Protect you can configure credit and address checks as well as bank account checks.

Operating Mode



Here you can specify for the credit standing check whether the checks are carried out in test or live mode.

Note: Please note that PAYONE requires the Protect module for your merchant account to be commissioned and activated in order to use these options. A faulty configuration leads to unwanted interruptions in the checkout process.

Credit Assessment

Here you can specify whether and in what form creditworthiness checks are to be carried out during the checkout process.


Field

Description

credit assessment

  • Do not carry out a credit standing check

    If this option is selected, no request is made to the PAYONE platform.
  • infoscore (hard characteristics)

    Checking 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)
    Inspection for all characteristics (see above) and delivery of the boniscore, which as a score value enables a higher selectivity for existing negative characteristics.

Service life in days

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 relevant shop buyer / user until the set period expires. If this field is empty, a request is always made.

Credit check from value of goods (€)

Market-basket value from which a credit check is carried out. If this field is empty, a request is always made.

Standard Credit Index

The customer receives this credit rating index when he registers.
Purpose: If the customer has not yet been checked and the check only takes place above a certain goods value, this is the credit rating index which is taken into account until the first actual check. If this field remains empty, the OXID standard is set (1000).

Credit assessment moment

Selection of:

  • Before selecting the payment method
  • After selecting the payment method
    If you select "After payment type selection", you can select the creditworthiness index for the payment type so that a check is only carried out for certain payment types.


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 standing check for payment types that entail a payment default risk for you (such as open invoices or direct debits). You configure this via the setting "Credit rating index" in the configuration of the respective 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 specify whether and in what form the address checks should be performed and how the OXID eShop should behave if certain results apply.


Field

Description

address validation

  • Do not perform an address check

    No address check is performed.
  • Address Check 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, the Netherlands, Belgium, Luxembourg, France, Italy, Spain, Portugal, Denmark, Sweden, Finland, Norway, Poland, Slovakia, Czech Republic, Hungary, USA, Canada).
  • Address Check 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).

Copy corrected address

If this checkbox is selected, an address corrected by the PAYONE platform is adopted.

Check delivery address

If this checkbox is selected, a different delivery address will also be checked on the basis of the selected address check.
Note: If the option "Apply corrected address" is selected, corrected delivery addresses will also be applied.

If address postal wrong, user will be sent back to user form

If the described condition applies, the user is asked again to enter his invoice/delivery data in the checkout.


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

Bank details check

Here you can configure whether and in what form bank details should be checked during the checkout process when the payment type Direct Debit is selected.


Field

Description

Checking the bank details

  • Deactivated Nocheck of the bank details is carried out.
  • Activated The system checks the plausibility of the account details.

    Note: No check is made for the existence of the bank details or account coverage.
  • Activated, with check against POS lock listAcheck of the bank details for plausibility is carried out and a check against the POS lock list is carried out.
    Note: Here, too, no check is made for the existence of the bank details or coverage of the account. The POS block file contains account connections with open chargebacks from stationary trading.


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

Transaction Status Forwarding


Transaction status forwarding enables you to transfer the payment status to other systems, such as Materials Management or Logistics.


Field

Description

status

The status sent by PAYONE.

URL

Enter the receive URL to which the status is to be forwarded.

timeout

Number of seconds to wait until the status is accepted.

Delete

Here you can delete the respective forwarding.

Save

Saving saves all redirects in the database.

Add

You can add as many redirects as you like. Also multiple forwarding for one and the same status.

Transaction Status Mapping


The transaction status mapping is used to use the PAYONE status in order to have the orders processed according to your needs in an appropriate shop status.

Field

Description

method of payment

The payment type for which the mapping is to apply.

PAYONE Status

The status sent from PAYONE to the shop.

Shop - Status

The status that the orders should assume when the configured PAYONE request is processed in the shop.

Delete

Here you can delete the respective mapping.

Save

Saving saves all mappings in the database.

Add

You can add any number of mappings. Please note, however, that only one mapping exists for a payment type and PAYONE status combination. This may lead to inconsistencies.

Use of the extension

Protocols / Logs

Within the menu item Protocols/Logs you will find all information about processed payments, the communication with the PAYONE platform as well as the order overview.

Transactions

The Transactions submenu item displays notifications received from the OXID eShop of the transaction status of the PAYONE platform for each order and transaction. 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.

Overview

In the overview you can see all received and processed messages of the transaction status of the PAYONE platform. Filter options are available above the individual columns.

Field

Description

time

Time at which the transaction status was received.

order number

The order number of the order in the OXID eShop.

transaction number

The unique number of the transaction (TXID). This number is assigned by the PAYONE platform.

payment method

The payment type used within this transaction is displayed here.
The following abbreviations are possible:
elv Direct debit
cc credit card
rec invoice
before prepayment
cod cash on delivery
sb online bank transfer
wlt e-Wallet (e.g. PayPal)
fnc Financing (e.g. klarna)

customer email

The e-mail address of the customer that was specified in the order.

amount

The amount in the currency used.

status

This displays the status transmitted by the transaction status of the PAYONE platform.
Note: An explanation of the individual statuses can be found in the technical documentation of the PAYONE platform in the PAYONE Merchant Interface (PMI) under Downloads > Documentation.

transaction details


After selecting an entry in the overview, you will receive all transmitted transaction status information through the PAYONE platform to your OXID eShop. This allows you to track at any time which data your OXID eShop 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 logs

In the submenu API-Logs you will find all requests from the OXID eShop to the PAYONE platform as well as the corresponding answer of the PAYONE platform.

The only requests that are not contained in these logs are requests using the Client API. The reason for this is that these requests are sent directly from the buyer's browser (client) to the PAYONE platform for reasons of the Payment Card Industry Data Security Standard based on Ajax technology, so that your OXID eShop does not technically come into contact with sensitive credit card data.

Overview

In the overview you will find a list of all requests from the OXID eShop to the Server API with basic information. You can filter the display in the column headers by entering search terms.

The entire content of the Request and Response columns is searched. The content is described in more detail in the API Log Details.

Field

Description

time

Time of the request.

channel

The channel used.

request

Type of request.

response

Parameter "status" from the response of the PAYONE platform to the request.

API Log Details


After clicking on one of the requests listed in the overview, you will see all parameters of the request sent to the PAYONE platform as well as the corresponding response from the PAYONE platform.
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.

Orders

The order overview is a standard functionality of the OXID eShop. The PAYONE tab has been added to this list in order to be able to check the payment status of an order.

Via the menu item Manage orders > Orders, which is available by default in every OXID eShop, the same overview including the PAYONE tab is displayed as under PAYONE > Protocols / Logs > Orders.

Overview

In the overview you will find a list of all orders with basic information. As with transactions and API logs, you can filter the display in the column headers by entering search terms.

Field

Description

order time

Time of order.

Paid

Time for reporting the payment from the PAYONE platform.

Order no.

Order number of the OXID eShop.

client

Name, first name of the customer.

PAYONE reference number

The reference number passed to the PAYONE platform for unique identification. The reference number is stored in the "reference" parameter.

PAYONE Tab

In the PAYONE tab you will find the transaction account in the context of the order, in which all receivables and payments are displayed. This is based on the OXID eShop requests via the Server API to the PAYONE platform as well as feedback on the transaction status from the PAYONE platform.
You also have the option of capturing payments for pre-authorized payment transactions and refunds.

Field

Description

reference number

The reference number passed to the PAYONE platform for unique identification. The reference number is stored in the "reference" parameter.

PAYONE Process number (TXID)

The transaction number under which the transaction was processed in the PAYONE platform.

method of payment

Payment type with which the order was executed.

payment details

Depending on the payment method, detailed information about the payment is listed here. For credit card payments, the fields Card type and Masked card number are displayed here as information.

amount

Depending on the payment status of the order, you can trigger a credit note (refund) or carry out a payment collection (capture) at this point.
Note: In the accounts receivable management in the PAYONE Merchant Interface (PMI) there are more far-reaching possibilities for the execution of captures, refunds etc. available. In addition, you can trigger these transaction types via your merchandise management system or/and? via the server API of the PAYONE platform.

transaction account

All receivables and payments for the purchase order are displayed here in the form of a transaction account. All negative amounts are displayed in red. Click on "Time" to open the corresponding transaction status.
Note: You can find further information on the respective payment transaction in customer management in the PAYONE Merchant Interface (PMI).

Help 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 Service Line at the following contact details