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 release and the accompanying documentation are valid for the following combinations of software versions:

Intershop	PAYONE Service Connector
ICM 12.0	8.0.0

PAYONE Connector version 8.0.0 provides the same functionality as PAYONE Connector 7.0.1 for the supported payment methods to facilitate the migration from ICM 11 to 12.

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.

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

 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:

Application Type	Application Type ID	Description
Progressive Web App	intershop.REST	Progressive Web App endpoint for B2C/B2B channel Supported payment methods: Credit Card PayPal Invoice PostFinance Card SOFORT Banking iDEAL

Feature Overview

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

Payment Methods

The PAYONE Service Connector adds the following payment methods to your Intershop Commerce Management system:

Payment Method Type	Details
PayPal	PayPal
Online Payment	SOFORT Überweisung
Credit Card	Credit 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 Payment	Invoice
Online Payment	iDEAL
	PostFinance Card

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

Payment Management Options

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

Operation	Description
Capture	Request for settling the payment. This action is only available if the corresponding payment method's capture mode is set to manual.
Cancel	Request for abandoning a payment settlement. This action is only available if the corresponding payment method's capture mode is set to manual.
Refund	Option to return (parts of) the capture amount.

There are certain limitations regarding the implemented capabilities, see Restricted Capabilities.

Setup

The customization image for the PAYONE Connector is available in Intershop's public repository. To add the customization image for the PAYONE Connector to your project, add it to the dependencies of your customization. To achieve this, perform the following steps:

1. Register the customization image in your main build.gradle.kts:
   

   val icmDockerRegistry = "docker.tools.intershop.com/icm/intershophub"
   // specified in gradle.properties
   val payoneConnectorVersion: String by project
   
   intershop {
       projectConfig {
           modules {
               // ... other modules ...
   
               register("payone") {
                   dependency.set("com.intershop.services.payment_payone:payone:${payoneConnectorVersion}")
                   image.set("${icmDockerRegistry}/icm-as-customization-payone:${payoneConnectorVersion}")
                   testImage.set("${icmDockerRegistry}/icm-as-customization-payone:${payoneConnectorVersion}")
               }
           }
       }
   }
   
   subprojects {
       // ... other settings ...
    
       plugins.withType<JavaPlugin> {
           dependencies {
               // ... other dependencies ...
    
               cartridge(platform("com.intershop.services.payment_payone:versions:${payoneConnectorVersion}"))
               implementation(platform("com.intershop.services.payment_payone:versions:${payoneConnectorVersion}"))
            }
       }
   }

   
   

2. Add dependencies to the PAYONE feature to your project's feature definition (e.g., ft_myproject/build.gradle.kts):

   dependencies {
       // base on ICM AS
       cartridgeRuntime ("com.intershop.icm:ft_icm_as")
       
       // ... more dependencies ...
   
       // PAYONE Connector
       cartridgeRuntime ("com.intershop.services.payment_payone:ft_payone")
   }

   To include the PAYONE feature, add your project's feature definition cartridge to your development configuration within your main build.gradle.kts. If you need additional feature cartridges for local development, you can add them here as well.

   intershop_docker {
       // ... other configuration ... 
       developmentConfig {
           appserverAsContainer = true
           cartridgeList.set(setOf("ft_myproject"))
           // alternative scenario using a feature cartridge where payone isn't included as a runtime dependency:
           // cartridgeList.set(setOf("ft_payone", "ft_my_other_feature_cartridge_dev"))
           testCartridgeList.set(setOf("ft_mytest"))
       }
   }

3. Start your application server.
   There are several ways to do so. The three main use cases are:

   1. Development mode:

      • Use Gradle to manage the server instance by using the command:
        gradlew startAS

      • Run gradlew tasks to see available tasks or check for further options.

   2. Local Docker environment using docker-compose:
      Adapt the compose file used to tell ICM which cartridges to load. To do this, use the CARTRIDGE_LIST environment variable on the application server:

      version: "3.8"
      services:
        customize-payone:
          image: icm-as-customization-payone:<TAG>
          volumes:
            - customizations:/customizations
        # ... other services ...
        appserver:
          # ... other appserver settings ...
          container_name: appserver
      
          environment:
            # ... more environment variables ...
            # example cartridge list (assuming the PAYONE Connector (ft_payone) is already defined as dependency). Please adapt to your needs.
            CARTRIDGE_LIST: "ft_myproject"    
      
      # ... more configuration ...

   3. Production environment using Helm charts:
      If Helm is used to manage the ICM instances, the cartridge list will need to be adjusted. Please follow Concept - Customization - Deployment - ICM 11+ to add the PAYONE Connector cartridges to that list.

For details on managing the artifacts, see:

• Concept - Customization - Development - ICM 11+

• Concept - Customization - Deployment - ICM 11+

The PAYONE Service Connector requires the following settings for the currencies you want to support: