Introduction

Welcome to the Intershop Commerce Management PAYONE Service Connector. The Service Connector adds PAYONE payment methods to your Intershop Commerce Management (ICM) installation.

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

Version Information and Dependencies

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

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

Cartridge	Description	Required
ac_payment_payone	Includes all base functionality and business logic which is used.
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.
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 credit card. 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.

The PAYONE Service Connector 6.x is based on the Payment API 3.4.

The source for as_responsive_payone and app_sf_responsive_payone is available here

<YOUR_REPOSITORY>/releases/com.intershop.public.source/s_payment_payone/<CONNECTOR_VERSION>/zips/s_payment_payone-zip-src-<CONNECTOR_VERSION>.zip

 Preconditions

• The PAYONE Service Connector requires an installed Intershop Commerce Management 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.

Supported Application Types

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

Feature Overview

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

Setup

Precondition

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

• A set up and configured CI environment
  See Cookbook - Setup CI Infrastructure for details.
  See Concept - Continuous Delivery Tools (valid to 7.10) for basic information about continuous integration.
• A running installation of ICM 7.10.31 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

Setting Up the Assembly

To add the PAYONE Service Connector into your Intershop Commerce Management system, you may either incorporate the cartridge into an already existing assembly or create a new assembly inheriting from an ICM-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:

   build.gradle file

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

   app_sf_responsive_payone/build.gradle file

   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:
   

   as_responsive_payone/build.gradle file

   ...
   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 to consume the desired version (e.g. 6.1.1).
   Example:

   intershopBuild.version

   com.intershop.services.payment_payone:ac_payment_payone = 6.1.1

   
   

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

For details about managing assembly artifacts, see:

• Concept - Gradle Assembly Tools
• Reference - Gradle Assembly Tools
• Cookbook - Gradle Assembly Tools

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:

This setting can be overridden within <IS_SHARE>/system/config/cartridges/ac_payment_payone.properties, see Recipe: Change Deployed File Content With Filters.

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

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

Configuration

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:

• Concept - Localization
• Cookbook - Localization

Data Handling

The following table describes transmitted data by the PAYONE Service Connector from ICM to PAYONE during the payment process:

	Description	PAYONE Payment Methods
		Invoice	Cash in Advance	Credit Card	Direct Debit	EPS	GiroPay	Paypal	Sofort	Ideal	PostFinance E-Finance	PostFinance Card	Paydirekt
Amount	The amount for the transaction
Currency	Currency code e.g. EUR/USD
Customer details (e-mail, first name, last name)	Customer e-mail, customer first name, and last name
reference (order id)	Order reference generated by the merchant
Address details (street, zip, city, country)	Invoice and shipping address details provided by the user (optional and configurable in back office)
de[line item details]	Array of product attributes, e.g. product name, value, discount, gift card (optional and configurable in back office)
bankgrouptype	Issuer of Online-Bank-Transfer
bankcountry	Country of the bank
Credit card details	Card number, CVC, expiry date Sensitive data is handled via PayGate iframes only and is never stored at the merchant.
language	Language indicator to specify the language that should be presented to the customer
Account holder name	Name of the account holder
IBAN	International Bank Account Number
BIC	Bank Identifier Code to be used for payment
Browser information	Browser details like javaEnabled, language, colorDepth, timezone, screenHeight, screenWidth, windowSize
Direct debit type	One time payment (single) Stored account (first/recurring)

Limitations

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.

Supported Countries and Currencies

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

Restricted Capabilities

• Cancel: No "cancel" capability for eps, iDEAL, PostFinance E-Finance, PostFinance Card and SOFORT Überweisung implemented.

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 (@) is being replaced by escape characters.

Testing

The payment method Giropay cannot be tested using the PAYONE sandbox anymore. The feature in the sandbox has been deactivated by PAYONE by now.

The payment methods were tested using test data officially provided by PAYONE.

Changelog

Version PAYONE/6.1.1

• Change: In ICM, you could set a value for the minimum card validity in months for PAYONE Credit Card Payment Service. However, this currently has no effect.
  Therefore, this configuration option has been removed for the time being to avoid confusion.
• Fix: Configuration properties for supported countries are also read when the payment methods default is "all countries".
• New feature: PWA support for PAYONE Sofort, EPS and iDEAL

Version PAYONE/6.0.4

• Bug #72865: Sensitive banking data are not logged in log files anymore
• User Story #70259: Reduce usage of error logs
• Bug #63932: Possible NullPointerException fixed, which may occur when no invoice address is assigned while the eligible payment methods are evaluated

Version PAYONE/6.0.0

• User Story #64351: Upgrade PAYONE Connector to Tomcat-9-based ICM (≥7.10.31)
• User Story #61543: Enable PAYONE Credit Card for PWA storefront
• Bug #62433: Handling 'PAID' notifications for Cash In Advance