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.

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 5.4.+ is based on the Payment API 2.8.

The source for "as_responsive_payone" and "app_sf_responsive_payone" is available here

...YOUR_REPOSITORY.../releases/com.intershop.public.source/s_payment_payone/5.4.8/zips/s_payment_payone-zip-src-5.4.8.zip

 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.

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

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:

   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:


   intershopBuild.version

   com.intershop.services.payment_payone:ac_payment_payone = 5.4.8

   
   

   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:

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.

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
• Cookbook - Localization (valid to 7.9)

Data Handling

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

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

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.

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.

Changelog

Version PAYONE/5.4.8

• PAYONE-476 - Payone Cash in Advance authorizes unpaid Orders: Fix in notification handling for Cash in Advance payments

Version PAYONE/5.4.7

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

Version PAYONE/5.4.6

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

Version PAYONE/5.4.3

PAYONE-319 - PAYONE - Milestone 4 - giropay - Implementation of payment method Giropay
PAYONE-323 - PAYONE - Milestone 4 - paydirekt - Implementation of payment method paydirekt
PAYONE-407 - PAYONE - Refund Error on Orders with Bigger amount on B2B and B2C - Fix in validation and handling of amount values
PAYONE-414 - SOFORT: IBAN and BIC have no effect in PAYONE side - Removed input field IBAN and BIC for SOFORT Überweisung
PAYONE-416 - SOFORT: Need to disable Cancel capability - Cancel capability removed from SOFORT Überweisung

Version PAYONE/5.3.6

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

Version PAYONE/5.3.5

PAYONE-192 - PAYONE - Invoice refund scenario issue - Refund capability for PAYONE Invoice was disabled via Intershop Commerce Management PAYONE-341 - Submit details not working in SOFORT - Transmit address information to PAYONE for payment method SOFORT ÜberweisungPAYONE-342 - Submit Order Details not working for PayPal - Transmit address information to PAYONE for payment method PayPal
PAYONE-345 - PAYONE B2B - 'Page not Found' error with Redirect scenarios - Payment methods using redirects are enabled for B2B application
PAYONE-352 - PAYONE B2B: Company first name not getting displayed in sandbox - First name of B2B customer will also be transferred to the PAYONE payment gateway
PAYONE-353 - PAYONE Paypal B2X: Cancel capability is not working - PayPal transactions in B2B application can be canceled now
PAYONE-384 - Cartridge ac_payment_payone_bo missing dependencies - Cartridge ac_payment_payone_bo missing dependencies

Version PAYONE/5.3.0

Implementation of the PostFinance Card PAYONE-324 - Implement PostFinance Card into PAYONE 5.3.0 for ICM 7.9 and additional capabilities (capture, refund) for PostFinance E-Finance PAYONE-217 - Complete missing capabilities PostFinance E-Finance.

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 PAYONE-199 solves this specific timing issue for all payment methods using redirect after checkout.

Version PAYONE/5.2.3

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

Version PAYONE/5.1.1

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