Document Tree
Document Properties
Last Modified
Added to KB
Public Access
Doc Type
Release Notes
  • ICM 7.10
  • PayPal
Related Product
Public Release Note - PayPal Service Connector 6


Welcome to the Intershop PayPal Service Connector. The service connector adds PayPal payment methods to your Intershop Commerce Management installation.

This release note 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:

Intershop CM


PayPal Service Connector

PayPal Core API

PayPal Merchant SDK

7.10.31.x+ (Tomcat 9)


6.0.0 - 6.0.4







The PayPal Service Connector 6 is based on the Payment API introduced in Intershop Commerce Management 7.6.1.


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





Includes all base functionality and business logic which is used both in the storefront and the Commerce Management application

Enables PayPal payment connector for the following application type:

  • intershop.REST



Enables PayPal 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 can be skipped if the custom project does not support these application types or PayPal is not required in these application types.



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 PayPal Service Connector 6.+ is based on the Payment API introduced in IS 7.6.

The sources for as_responsive_paypal and app_sf_responsive_paypal are available here


Compatibility of Application Types

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

Application Type

Application Type ID



B2C WebShop



Business to Consumer Channel

SMB WebShop



Business to Business Channel


Only applicable if the order approval is disabled!

Progressive Web App



B2C/B2B via REST


This section outlines the basic setup and configuration steps, including


Managing and deploying the PayPal Service Connector requires a continuous integration environment being set up and configured as described in Cookbook - Setup CI Infrastructure (valid to Gradle Tools 2.7).


The package is available via Intershop's public Artifactory.

Setting Up the Assembly

To add the PayPal Service Connector to your Intershop Commerce Management system, you may either:

  • Incorporate the cartridge into an already existing assembly. To do so, perform the following steps:

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

      cartridges {    
              def paypalPaymentProvider = [
      // these are the two cartridges, which we delivered in source code and you have to add these files to your responsive source project
              include (*(paypalPaymentProvider.collect {"$it"}), in: [development, test, production])
              order = listFromAssembly(<yourAssembly>) + paypalPaymentProvider

    2. Adapt the app_sf_responsive_paypal/build.gradle file in the following way:
      app_sf_responsive_paypal/build.gradle file

      apply plugin: 'static-cartridge'
      apply plugin: 'com.intershop.gradle.isml'
          displayName = 'Adapter Cartridge for Paypal Payment'
          packages {
              cartridge {
          //compile project(':ac_payment_paypal') --> will be replaced by
           compile group: '', name: 'ac_payment_paypal'

    3. Adjust the file as_responsive_paypal/build.gradle in a similar way:
      as_responsive_paypal/build.gradle file

      apply plugin: 'static-cartridge'
          displayName = 'As_responsive_paypal'
          staticLibs = fileTree(dir: staticCartridgeLibFolder, include: '*.jar')
      dependencies {
          //compile project(':ac_payment_paypal') --> will be replaced by
           compile group: '', name: 'ac_payment_paypal'
          compile project(':app_sf_responsive_paypal')

    4. Insert the following lines into the file intershopBuild.version to consume the desired version (e.g. 6.0.4):

      intershopBuild.version = 6.0.4

    For details about adding components to an assembly, see Cookbook - Gradle Assembly Tools.

  • Create a new assembly inheriting from an Intershop Commerce Management system-based assembly.
    For details about creating a new assembly, see Recipe: Create a New Assembly Inheriting From an Existing Assembly.

For details about managing assembly artifacts, see:

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 PayPal Service Connector.

The PayPal Service Connector requires the following settings:





Defines which currencies are configurable for PayPal Standard. Default: EUR,AUD,GBP,DKK,HKD,JPY,CAD,MXN,ILS,NZD,NOK,PLN,SEK,CHF,SGD,CZK,HUF,USD

comma separated list, e.g., EUR, USD


Defines which currencies are configurable for PayPal Express Default: EUR,AUD,GBP,DKK,HKD,JPY,CAD,MXN,ILS,NZD,NOK,PLN,SEK,CHF,SGD,CZK,HUF,USD

comma separated list, e.g., EUR, USD

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

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

Deploying the Assembly

After having created and appropriately having configured 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).


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


Changing the Definition of Significant Cart Change

The consequent redirects to PayPal (those after the initial redirect) are done after significant cart changes. What is significant in a cart is defined by the class:


public class BasketHashCodeGenerator implements Function<BasketBO, String>

It gets the current BasketBO and creates a hash based on what it considers to be significant.

At some stages of the checkout (payment and review pages) a hash is generated again and if there is a mismatch with the initial hash, the customer will be redirected to PayPal again.

To change the definition of what is significant in a cart:

  1. Create your own class YourCustomBasketHashCodeGenerator implementing Function<BasketBO, String>, which generates a hash based on what you consider significant.

  2. Bind the new class in your customization Guice module.

    bind(new TypeLiteral<Function<BasketBO, String>>()


This section outlines the required post-deployment configuration steps, including:

Adjusting Firewall Settings

Adjust your firewall settings according to PayPal's Go Live Checklist.

Applying UI Based Configuration

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

For details about enabling a payment service, see - Recipe: Enable a Payment Service.
The table below lists PayPal-specific settings you can enter at the payment service.



User Name

Your PayPal seller account's username.


Your PayPal seller account's password.


Your PayPal seller account's signature.


Switch between test and live system. Options: live, sandbox, and beta-sandbox.

Logo URL

The URL of the logo that will be displayed on the PayPal page after redirect.

Branding ID

The heading that will be displayed on the PayPal page after redirect. Overrides the logo parameter.

Page Layout

The identifier of the preconfigured page style that will be used for the PayPal page after redirect. Overrides the logo parameter.

Auto Capture

If enabled, the amounts will be automatically captured with the authorization.

Allow PayPal address update

If enabled, the customer can update the shipping address via the PayPal page. This does not apply to orders which contain multiple shipping buckets. For those, the address update is always disabled.

Allow shipping buckets

Enable PayPal for orders being dispatched to multiple addresses or in multiple shipments.

Digital goods

If enabled, the customer can buy Digital Gift Certificate.

PayPal Logo URL

URL of the PayPal logo, which is shown under PayPal payment methods.

Transfer Order Details

Specifies the way to transfer order details to PayPal. Order details include items (prices and quantities), discounts, taxes, handling fees, etc.
See also: Order Detail Transmission Options.

PayPal confirmation button type

Modifies the text value of the PayPal confirmation button.


The PayPal 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_paypal/release/localizations

For details about localization, see:

Feature Overview

Payment Methods

The PayPal Service Connector adds the following payment methods to your Intershop CM system:



Payment Management Options

PayPal Standard

Payment via a PayPal account performing the complete authorization/capturing process

Capture, Cancel, Reduce, Refund

PayPal Express

Payment via a PayPal account using the express checkout button and performing the complete authorization/capturing process


The express checkout feature is not available for the Intershop PWA.

Capture, Cancel, Reduce, Refund

Payment Management Options




Request for settling the payment, can be submitted via the Intershop Commerce Management or via the PayPal Web interface.


Request for abandoning (PayPal: voiding) a payment settlement, can be submitted via the Intershop Commerce Management or via the PayPal Web interface.


Option to lower the capture amount


Option to return (parts of) the capture amount


Capture and Cancel operations performed directly in the PayPal Web interface are not synchronized with Intershop Commerce Management. This leads to errors when trying to capture or to cancel those payments in the Intershop Commerce Management.

Order Detail Transmission Options

The PayPal Connector supports different options for transmitting order details to PayPal. To avoid rounding errors it might make sense to adapt this setting within a project in order to make it possible to use PayPal for all use cases.

Explaining Rounding Errors

Rounding errors may occur when transferring the basket to a payment service provider (PSP). When a PSP provides an API to send the different basket totals with 2-digit values (e.g., shipping, taxes, discounts etc.) there is a possibility that summing up everything with 5-digit values will produce a different result than the total amount for authorization. The difference might be as small as a cent, but still enough for the PSP to reject the payment. The reason for rounding issues is price calculation which includes percentage values. For example:

  • Converting net prices into gross prices
    This may happen when prices in the Commerce Management application are handled as net and displayed in the storefront as gross.
  • Percentage-based discounts

Avoiding Rounding Errors

Since version 4.1 of the PayPal Connector the shop manager has three options to transfer order details (basket transmission) to PayPal.

ICM OptionPossible Rounding IssuesExplanationResult at PayPal
No DetailsnoNo details besides the order total appear at PayPal
All Details as Subtotalno

The connector uses parts of the PayPal API.

Order details appear at PayPal as part of the item list.

Details Separatedyes

The connector uses most of the PayPal API.

Order details appear at PayPal at dedicated places.

Redirecting on Significant Cart Changes

Once the customer is redirected back from PayPal, the contents of the basket are stored as hash. If significant changes are observed before the order is completed, the customer would be redirected again to PayPal to confirm the payment. Such redirects may occur on the payment and review pages of the checkout process.

  • Significant changes are:

    • Product quantity change

    • Adding a product

    • Removing a product

    • Changing the whole or parts of the shipping address:

      • Country

      • City

      • Postal code

      • Address Line 1

  • Significant changes are not:

    • Shipping method change

    • Invoice address changes

Tax Changes

It is possible (although very rarely) that the customer is redirected for a second time to PayPal, not influenced by the customer's actions. This may be observed for example if a tax is applied to a product in the ICM storefront, but the tax is later changed due to an address change when redirecting back from PayPal. This causes a change of the total amount of the basket, which is considered a significant change and the customer will be redirected again to PayPal to confirm the payment.

Data Handling

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


PayPal Payment Methods

 PayPal Standard

PayPal Express


The amount for the transaction




Currency code e.g. EUR/USD



Customer details

Customer e-mail, customer first name, last name, country, city, postal code, mobile number



Shipping Details

Shipping amount, shipping discount



Reference (order id)

Order reference generated by merchant



Address details (street, zip, city, country) 

Invoice and shipping address details provided by the user 



Description of the items

Product description (optional and configurable in back office)








Not Transmitted




General Limitations

Matching Price and Taxation Calculation

Please be aware that the PayPal payment cartridge requires a matching price display and tax calculation. That is, the price type and the price display must be either both set to "gross" or both set to "net", and a corresponding taxation service must be enabled.

PayPal Express: Customer Redirect to Payment Page Instead of Review Page

A customer being logged in will be redirected to the payment page (not the review page) after confirming payment at PayPal.

However, this does not affect the functionality of the cartridge.

Application Types

The payment methods are available for B2C shops and for those B2B shops in which the order approval is disabled.

PayPal Express for PWA

The express checkout feature is not available for the PWA storefront. The option for express checkout using PayPal will not be available to the user in that case.

PayPal Address Update Not Possible for Orders with Multiple Shipping Buckets

It is possible to enable both "Allow PayPal address update" and "Allow shipping buckets" at the same time. However, if multiple shipping addresses are used for some line items of a basket, it will not be possible to distinguish between those addresses at PayPal. Only one address is set on the PayPal redirect page, which would lead to the different shipping addresses being overwritten with this single address when returning from the PayPal redirect. Therefore, in case of orders with multiple shipping buckets, the address update setting will be disabled at runtime, regardless of the configuration.

PayPal in combination with PWA

Due to a bug in the PWA 3.2 the redirect is not working in combination with that release. The issue is fixed since version 3.3.

Credit Card with IPv6 Addresses

The IP zones feature requires an IPv4 address on the customer's side. In case the customer has an IPv6 address, the payment method Credit Card will not be displayed on the payment page.


Version PayPal/6.1.1

  • Added localization keys for PayPal Standard- and PayPal Express-specific payment history entries

  • Improved handling of PayPal-specific errors within capture functionality

  • Fixed issue blocking usage of multiple configurations for same service on the same level

  • Fixed bug where payment transaction information could not be sent for products with missing product name

Version PayPal/6.0.4

  • Fixed address update handling in case of multiple shipping buckets

  • Sensitive banking data are not logged in log files anymore

  • Fixed determination of fallback total amount to avoid issues when sending order details to PayPal

Version PayPal/6.0.0

  • Support of PayPal Standard within PWA

  • Upgrade of PayPal Connector to Tomcat-based ICM (≥7.10.31)

  • Removed dependency to responsive cartridge from PayPal

  • Improved usage of error log

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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to if you experience login issues,
or if you want to register as customer.