Public Release Note - PAYONE Service Connector 5

1 Introduction

Welcome to the Intershop 7 PAYONE Service Connector. The Service Connector adds PAYONE payment methods to your Intershop 7 installation.

This document provides important product information, including version information and dependencies. It also outlines the basic setup and configuration steps.

1.1 Version Information and Dependencies

This delivery and the accompanying documentation are valid for the following combinations of software versions:

IntershopPAYONE Service Connector
7.8.2.45.1.1

7.8.2.10+
7.9.0.9+
7.10.2.1+

5.4.3

7.8.2.10+
7.9.4.0+

7.10.15.3+

5.4.6


5.4.7

The next table provides information about the cartridges included in the package. Not all of these cartridges are required.

CartridgeDescriptionRequired
ac_payment_payoneIncludes all base functionality and business logic which is used.(tick)
as_responsive_payone

Enables the PAYONE payment connector for the following application types:

  • intershop.B2CResponsive
  • intershop.SMBResponsive

The cartridge is optional, can be downloaded separately from Intershop Product Calendar and may be included if the project uses the responsive starter store. Unzip the file to your multi-project folder next to your responsive source files. It could be skipped if the custom project does not support these application types or PAYONE is not required in these application types.

(error)
app_sf_responsive_payone

Includes some additional functionality which is relevant for the responsive storefront reference application only, e.g., the integration of the hosted payment pages of the CreditCard.

The cartridge is optional, can be downloaded separately from Intershop Product Calendar and may be included in case the project is based on the responsive storefront reference application. Unzip the file to your multi-project folder next to your responsive source files. The referenced cartridge app_sf_responsive may be renamed in the project and has to be referenced in the build.gradle file with the customized naming again.

(error)

The PAYONE Service Connector 5.4.+ is based on the Payment API 2.8.

The sources for "as_responsive_payone" and "app_sf_responsive_payone" can be downloaded here (Use your repository login and assword for authorization):

https://repository.intershop.de//releases/com.intershop.public.source/s_payment_payone/5.4.7/zips/s_payment_payone-zip-src-5.4.7.zip

 

1.2 Preconditions

  • The PAYONE Service Connector requires an installed Intershop 7 system. See version numbers above.
  • Using the PAYONE Service Connector requires a dedicated payment provider contract with vendor PAYONE.
    Make sure to contact PAYONE to negotiate and sign your payment provider contract.

1.3 Supported Application Types

The PAYONE Service Connector can be used for the following application types:

Application TypeApplication Type IDDescription
B2C WebShopintershop.B2CWebShopBusiness to Consumer Channel
SMB WebShopintershop.SMBWebShop

Business to Business Channel

Warning

Only applicable if the order approval is disabled.

2 Feature Overview

This section summarizes important features delivered with the PAYONE Service Connector.

2.1 Payment Methods

The PAYONE service connector adds the following payment methods to your Intershop 7 system:

Planned ReleasePayment Method TypeDetails
5.1PayPalPayPal
Online PaymentSOFORT Überweisung
5.2Credit CardCredit Card Payment with:
  • Visa
  • Mastercard
  • American Express
  • Carte Bleue
  • Diners Club
  • Discover
  • JCB
  • Maestro International

This payment method uses Payone iFrames to enable compliance with PCI-DSS. It supports 3DS version 1.0 and 2.0.

Account Based PaymentCash in Advance
Direct Debit
Invoice
Online PaymentiDEAL
PostFinance E-Finance
eps
5.3Online PaymentPostFinance Card
5.4Online Paymentgiropay

Account Based Paymentpaydirekt
Later versionsAccount Based PaymentCash on Delivery
Klarna Invoice

Intershop's customers can safely use IS7 in PCI certified environments without impacting their certification status. Furthermore, IS7 provides features and configurability needed to implement all the requirements of the PCI Compliance program.

2.2 Payment Management Options

The following table lists all options that are available for payment transactions.

OperationDescription
CaptureRequest for settling the payment. This action is only available if the corresponding payment method's Capture Mode is set to manual.
CancelRequest for abandoning a payment settlement. This action is only available if the corresponding payment method's Capture Mode is set to manual.
RefundOption to return (parts of) the capture amount.

3 Setup


Note

Managing and deploying the PAYONE Service Connector requires a continuous integration environment set up and configured as described in Cookbook - Setup CI Infrastructure.

3.1 Precondition

The package is available via Intershop's Public Repository (Artifactory). The following preconditions are needed:

  • A set up and configured CI environment
    See Cookbook - Setup CI Infrastructure for details.
    See Concept - Continuous Delivery Tools for basic information about Continous Integration.
  • A running installation of Intershop 7.8 or later that matches the system requirements
  • Knowledge of how to add the delivered artifacts to the continuous integration environment
  • Knowledge of how to deploy to a test or production environment

3.2 Setting Up the Assembly

To add the PAYONE Service Connector into your Intershop 7 system, you may either incorporate the cartridge into an already existing assembly or create a new assembly inheriting from an Intershop 7 based assembly. For details about the latter, see Recipe: Create a New Assembly Inheriting From an Existing Assembly. For incorporating the cartridge into an already existing assembly, perform the following steps:

  1. Add the following in the build.gradle file of the assembly:

    ...
     
    cartridges {
            def storefrontCartridges = [
                'app_sf_responsive',
                'app_sf_responsive_cm',
                'app_sf_responsive_b2c',
                'app_sf_responsive_smb',
                'as_responsive',
                'app_sf_responsive_b2b',
                'app_sf_responsive_costcenter',
                'as_responsive_b2b',
    // this are the two cartridges, which we delivered in source code and you have to add these files to your responsive source project
                'as_responsive_payone',
                'app_sf_responsive_payone'
               ]
            include(*(storefrontCartridges.collect { project(":$it") }), in:[development, test, production])
      
    ...
     
            def payonePaymentProvider = [
                'ac_payment_payone', 
            ]
            include (*(payonePaymentProvider.collect {"com.intershop.services.payment_payone:$it"}), in: [development, test, production])    
      
            order = listFromAssembly(baseAssembly) + payonePaymentProvider 
        }
    ...
    assemblyBuild {
        database {
            inherit(<yourAssembly>)
            initCartridges = []
        }
    }
    ...
    configurations.all {
        exclude group: 'com.sun.xml.bind', module: 'jaxb-impl'
    }
    
    
    
  2. Adapt the app_sf_responsive_payone/build.gradle file in the following way:

    apply plugin: 'static-cartridge'
     
    intershop
    {
           displayName = 'Adapter - Payment PAYONE - Business Extensions'
    }
     
    dependencies
    {
    //   compile project(':ac_payment_payone') --> will be replaced by
         compile group: 'com.intershop.services.payment_payone', name: 'ac_payment_payone'
    
       compile group: 'com.intershop.platform', name: 'businessobject'
    ...
       compile group: 'com.intershop.business', name: 'bc_payment'
     
    // compile group: 'com.intershop.responsive', name: 'app_sf_responsive' --> will be replaced by
       compile project(':app_sf_responsive')
      
    ...
    }
    
    
  3. Adjust the file as_responsive_payone/build.gradle in a similar way:

    ...
    dependencies {
     //   compile project(':ac_payment_payone') --> will be replaced by
         compile group: 'com.intershop.services.payment_payone', name: 'ac_payment_payone'
        compile project(':app_sf_responsive_payone')
    }
    ...
  4. Insert the following lines into the file: intershopBuild.version:

    com.intershop.services.payment_payone:ac_payment_payone = 5.4.7


    For details about adding components to an assembly, see Recipe: Add Cartridges to an Assembly.

Please note that the adapter cartridge will only work with a storefront that is based on the inSPIRED demo shop. It will not work in the PrimeTech demo shop.

For details about managing assembly artifacts, see:

3.3 Defining File-Based Configuration

Before deploying the new assembly to a test or production environment, you may have to adjust some file-based configurations required by the PAYONE Service Connector.

The PAYONE Service Connector requires the following settings:

PropertyDescriptionValue
intershop.payment.Payone_Cash_In_Advance.currenciesDefines which currencies are configurable for PAYONE Cash in Advance. Default: EUR.comma-separated list, e.g., EUR
intershop.payment.Payone_CreditCard.currenciesDefines which currencies are configurable for PAYONE Credit Card. Default: all.comma-separated list, e.g., EUR, USD
intershop.payment.Payone_DirectDebit.currenciesDefines which currencies are configurable for PAYONE Direct Debit. Default: EUR.comma-separated list, e.g., EUR
intershop.payment.Payone_Eps.currenciesDefines which currencies are configurable for PAYONE eps. Default: EUR.comma-separated list, e.g., EUR
intershop.payment.Payone_IDeal.currenciesDefines which currencies are configurable for PAYONE iDEAL. Default: EUR.comma-separated list, e.g., EUR
intershop.payment.Payone_Invoice.currenciesDefines which currencies are configurable for PAYONE Invoice. Default: EUR.comma-separated list, e.g., EUR
intershop.payment.Payone_PayPal.currenciesDefines which currencies are configurable for PAYONE PayPal. Default: all.comma-separated list, e.g., EUR, USD
intershop.payment.Payone_PostFinance_EFinance.currenciesDefines which currencies are configurable for PAYONE PostFinance E-Finance. Default: CHF.comma-separated list, e.g., CHF
intershop.payment.Payone_PostFinance_Card.currenciesDefines which currencies are configurable for PAYONE PostFinance Card. Default: EUR & CHF.comma-separated list, e.g., EUR, CHF
intershop.payment.Payone_Sofort.currenciesDefines which currencies are configurable for PAYONE SOFORT Überweisung. Default: EUR.comma-separated list, e.g., EUR
intershop.payment.Payone_Giropay.currenciesDefines which currencies are configurable for PAYONE giropay. Default: EUR.comma-separated list, e.g., EUR
intershop.payment.Payone_Paydirekt.currenciesDefines which currencies are configurable for PAYONE paydirekt. Default: EUR.comma-separated list, e.g., EUR

According to Recipe: Change Deployed File Content With Filters this setting has to be overridden within <IS_SHARE>/system/config/cartridges/ac_payment_payone.properties.

For details about adding new configuration files, see Recipe: Deploy Custom Files.

3.4 Deploying the Assembly

After creating and appropriately configuring the assembly, you must deploy it to the intended target environment.

For details about deploying an assembly see Recipe: Run the Deployment (Initial Installation / Upgrade / Downgrade)

Note

The PAYONE Service Connector requires additional post-deployment configuration steps. For details, refer to Configuration.

4 Configuration

4.1 Adjusting Firewall Settings

Adjust your firewall settings to allow bidirectional HTTP and HTTPS traffic between Intershop 7 and:

  1. api.pay1.de/post-gateway/
  2. secure.pay1.de/client-api/

Make sure that the ViewPayone pipeline is accessible from the available PAYONE IP addresses only.

4.2 Applying UI-Based Configuration

The PAYONE Service Connector requires some post-deployment configurations in Organization Management and Commerce Management.

Please consult the PAYONE documentation for information on how to setup your payment portal.

4.2.1 Configuring the PAYONE Shop Portal

Aside from the standard PAYONE shop portal configuration that is described in the PAYONE documentation, you should also configure the TransactionStatus URL.

ExplanationImage

PMI: https://login.pay1.de/

1. Enter Username.

2. Enter Password.

3. Click Login.

4. Click Configuration.

5. Click Payment Portals.

6. Select your portal and press Edit.

7. Click Extended.

8. Enter Success URL.

9. Enter Back URL.

10. Enter TransactionStatus URL.

(Set the TransactionStatus URL to point to the ViewPayone-Notify pipeline.
Assuming there is no URL rewriting, it should look similar to this: 'https://<host>:<port>/INTERSHOP/web/WFS/<site>/<locale>/-/<currency>/ViewPayone-Notify'. )

11. Click Save.


4.2.2 Enabling and Configuring a Payment Service 

Check the available Recipe - Enable a Payment Service in the Cookbook - Payment to get detailed instructions about enabling and configuring a payment service.


Payment-Method-Specific Settings:
NameDescription
Merchant-IDYour merchant account's merchant ID as provided by PAYONE.
Portal-IDYour merchant account's portal ID as provided by PAYONE.
Sub-Account-IDYour merchant account's sub account ID as provided by PAYONE.
Portal-KeyYour merchant account's portal key as provided by PAYONE (unencrypted).
Productive ModeSwitch between productive and test environment (unchecked, set as default).
OR
Check this checkbox on the live system. Leave unchecked for text environment.
Base URLPAYONE Gateway URL.
CaptureThis describes the capture mode (Manual, Auto). If Timed is used you must set a Capture Time in Hours.
For all online payment methods (giropay, SOFORT Überweisung, iDeal, eps, Post-Finance EFinance and Post-Finance Card) capture must be set to Auto.
Bank Account CheckIf checked, the bank account check is enabled. Available for Direct Debit.
Submit Order DetailsIf checked, product line items are transmitted to PAYONE.
Use PAYONE Mandate ManagementEnables the usage of PAYONE mandate management. Available for Direct Debit.
Download mandate as PDFEnables the download of PAYONE mandate as PDF. Available for Direct Debit.
Ask For CVCAsk for Card Security Code (CVC/CSC/CVV/CID). Available for Credit Card.
Minimum Validity of CardMinimum remaining validity of credit cards in months. Available for Credit Card.


You can see the needed PAYONE values by going to the API-Parameter tab of your PAYONE shop portal.

4.2.3 File-Based Configuration

A part of the payment method configuration is not meant to be changed in the Commerce Management application and is available through server properties. These properties are read using the configuration framework and as such can be overridden for an application type. For more information on the configuration framework, check the available Concept - Configuration (valid to 7.10.11) and Cookbook - Configuration.

4.2.3.1 Credit Card iFrame Styles

For the configuration of the styles the credit card payment method can be adjusted with following properties:

PropertyValuesDescription
payment.payone.creditcard.<field>.sizePositive numberDetermines the size of the input field. Default = 4
payment.payone.creditcard.<field>.maxlengthPositive numberDetermines the length of the input field. Default = 4
payment.payone.creditcard.<field>.widthStringDetermines the width of the iframe that holds the field. The unit of the width has to be specified the same way it would be specified in a CSS style (e.g., 60px).
payment.payone.creditcard.defaultStyle.heightStringDetermines the height of the iframe that holds the field. The unit of the height has to be specified the same way it would be specified in a CSS style, Default = 34px
payment.payone.creditcard.defaultStyle.widthStringDetermines the width of the iframe that holds the field. The unit of the width has to be specified the same way it would be specified in a CSS style. Default = 250px
payment.payone.creditcard.defaultStyle.inputStringDefault CSS style to be used with text fields.
payment.payone.creditcard.defaultStyle.selectStringDefault CSS style to be used with select fields.

1 - <field> identifies which PAYONE credit card field is affected by the property. Supported values are cardtypes, cardnumber, cardcvc2, cardexpiremonth, cardexpireyear, e.g., payment.payone.creditcard.cardcvc2.width.

4.2.3.2 Supported Countries

For each payment method a list of supported countries can be defined. A comma-separated list of ISO 3166 ALPHA 2 country codes (also see PAYONE API documentation) is valid. The value '*' can be used if there is no restriction.

PropertyDefault

intershop.payment.Payone_Sofort.countries

AT,DE,CH,NL

intershop.payment.Payone_Eps.countries

AT

intershop.payment.Payone_DirectDebit.countries

DE,AT

intershop.payment.Payone_IDeal.countries

NL

intershop.payment.Payone_PostFinance_EFinance.countries

CH

intershop.payment.Payone_PostFinance_Card.countries

CH

intershop.payment.Payone_Giropay.countries

DE

intershop.payment.Payone_Paydirekt.countries

DE

intershop.payment.Payone_PayPal.countries

*

intershop.payment.Payone_Invoice.countries

*

intershop.payment.Payone_Cash_In_Advance.countries

*
intershop.payment.Payone_CreditCard.countries*

4.3 Localization

The PAYONE Service connector provides English and German localization for payment-specific input field labels, error messages etc.

You can find the existing localization files here: <IS.INSTANCE.SHARE>/system/cartridges/ac_payment_payone/release/localizations.

For details about localization, see:

5 Limitations

5.1 Gross Price and Taxation Calculation

The PAYONE payment service requires a gross-based price and tax calculation. That is, the price type and the price display must be set to gross, and a gross-based taxation service must be enabled.

5.2 Supported Countries and Currencies

Most of the payment methods included in this package are specific for certain countries or currencies.

Payment MethodSupported CountriesSupported Currencies
Direct DebitDE, ATEUR
epsATEUR
iDEALNLEUR
PostFinance E-FinanceCHCHF
PostFinance CardCHEUR, CHF
SOFORT ÜberweisungDE, AT, CH, NLEUR
Invoice*EUR
giropayDEEUR
paydirektDEEUR

5.3 Restricted Capabilities

  • Cancel: No "cancel" capability for eps, iDEAL, PostFinance E-Finance, PostFinance Card and SOFORT Überweisung implemented.
  • Refund:  The "refund" business process works after a delay of 24 h minimum until the bank reported the status back to PAYONE. Since there is no possibility to retrieve this precondition from PAYONE, the refund cannot be disabled.

5.4 Length of E-Mail Addresses

The length of e-mail addresses is limited to 50 characters on PAYONE side. Only 48 of these characters are usable because the at sign gets replaced by escape characters.

6 Changelog

6.1 Version PAYONE/5.4.7

  • New Feature: added support for logging mechanism in ICM 7.10

6.2 Version PAYONE/5.4.6

PAYONE-198 - Restriction messages for multiple buckets
PAYONE-427 - Page not found when last name is too short
PAYONE-430 - Issue with saving card details

6.3 Version PAYONE/5.4.3

PAYONE-319 - Implementation of payment method Giropay
PAYONE-323 - Implementation of payment method paydirekt
PAYONE-407 - Fix in validation and handling of amount values
PAYONE-414 - Removed input field IBAN and BIC for SOFORT Überweisung
PAYONE-416 - Cancel capability removed from SOFORT Überweisung

6.4 Version PAYONE/5.3.6

PAYONE-405 - Notifications are not ignored when arriving before redirect (only relevant for ICM 7.8)

6.5 Version PAYONE/5.3.5

PAYONE-192 - Refund capability for PAYONE Invoice was disabled via Intershop Commerce Management
PAYONE-341
- Transmit address information to PAYONE for payment method SOFORT
PAYONE-342
- Transmit address information to PAYONE for payment method PayPal
PAYONE-345 - Payment methods using redirects are enabled for B2B application
PAYONE-352 - First name of B2B customer will also be transferred to the PAYONE payment gateway
PAYONE-353 - PayPal transactions in B2B application can be canceled now
PAYONE-384 - Cartridge "ac_payment_payone_bo" missing dependencies

6.6 Version PAYONE/5.3.0

Implementation of the PostFinance Card PAYONE-324 and additional capabilities (capture, refund) for PostFinance E-Finance PAYONE-217.

6.7 Version PAYONE/5.2.4

When payment notifications are returned before the redirect process to the payment service provider was completed, the order status was not updated. The bugfix  ISPAYCON-238 solves this specific timing problem for all payment methods using redirect after checkout.

6.8 Version PAYONE/5.2.3

Migration of Credit Card, Invoice, Direct Debit, Cash in Advance, eps, iDEAL and PostFinance E-Finance o the new Payment API.

6.9 Version PAYONE/5.1.1

Migration of PayPal and SOFORT Überweisung to the new Payment API.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets