Introduction

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.

References

• Concept - Payment Framework
• Cookbook - Payment
• Concept - Intershop Reference Payment Services

Version Information and Dependencies

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

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

Delivery

The package includes the following cartridges:

• ac_payment_paypal
• as_responsive_paypal

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

Cartridge	Description	Required
ac_payment_paypal	Includes all base functionality and business logic which is used both in the storefront and the Commerce Management application
as_responsive_paypal	Enables PayPal payment connector for the following application types: intershop.B2CResponsive intershop.SMBResponsive The cartridge is optional and may be skipped if the custom project does not support these application types or PayPal is not required in these application types.

Compatibility of Application Types

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

Application Type	Application Type ID	Compatible	Description
B2C WebShop	intershop.B2CResponsive		Business to Consumer Channel
SMB WebShop	intershop.SMBResponsive		Business to Business Channel Warning Applicable only if the order approval is disabled!
Progressive Web App	intershop.REST		B2C/B2B via REST (planned for future release)

Setup

This section outlines the basic setup and configuration steps, including

Precondition

The package is available via Intershop's Public Artifactory.

• A set up and configured CI environment
  See Cookbook - Setup CI Infrastructure (valid to Gradle Tools 2.7) for details.
  See Concept - Continuous Delivery Tools (valid to 7.10) for basic information about Continuous Integration.
• A running Intershop Commerce Management 7.8, 7.9 or 7.10 installation 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

Set Up the Assembly

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

• Incorporate the cartridge into an already existing assembly.
  In the build.gradle file of the assembly add:

  cartridges {
          def paypalPaymentProvider = [
              'ac_payment_paypal', 
              'as_responsive_paypal'
          ]
          include (*(paypalPaymentProvider.collect {"com.intershop.services.payment_paypal:$it:5.0.8"}), in: [development, test, production])    
   
          order = listFromAssembly(baseAssembly) + paypalPaymentProvider
      }
  ...

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

• Create a new assembly inheriting from an Intershop Commerce Management 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:

• Concept - Gradle Assembly Tools
• Reference - Gradle Assembly Tools
• Cookbook - Gradle Assembly Tools (valid to 7.8)

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:

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

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

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

Customization

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:

@Named("PayPal_BasketHashCodeGenerator")
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 hash based on what you consider significant.

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

   bind(new TypeLiteral<Function<BasketBO, String>>()
   {
   }).annotatedWith(BasketHashCodeGenerator.class.getAnnotation(Named.class))
                .to(YourCustomBasketHashCodeGenerator.class).in(Singleton.class);

Configuration

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.

Localization

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:

• Concept - Localization
• Cookbook - Localization

Feature Overview

Payment Methods

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

Payment Management Options

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 Option	Possible Rounding Issues	Explanation	Result at PayPal
No Details	no	No details besides the order total appear at PayPal
All Details as Subtotal	no	The connector uses parts of the PayPal API. Order details appear at PayPal as part of the item list.
Details Separated	yes	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

Data Handling

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

Limitations

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 logged in customer 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.

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.

Changelog

Version PAYPAL/5.0.8

• Bugfix: PAYPAL-172 - Syntax in logback configuration updated

• Bugfix: PAYPAL-162 - Fix handling of long refund message to avoid failing call

• Improvement: PAYPAL-156 - Removed "ISH" and "Service" from payment service names

• Improvement: PAYPAL-142 - Applicability checks log more information for failed checks

Version PAYPAL/5.0.3

• Bugfix: PAYPAL-153 - Disabled "Allow PayPal address update" feature does not change original shipping address anymore
• Bugfix: PAYPAL-150 - Fixed NPE
• Bugfix: PAYPAL-146 - Fix mapping of first name and last name when taking over addresses from PayPal account
• Bugfix: PAYPAL-139 - Removed wrong error message when customer buys digital goods

Version PAYPAL/5.0.2

• Bugfix: PAYPAL-144 - Ensure compatibility of PayPal Express Checkout with ICM 7.9

Version PAYPAL/5.0.1

• New Feature: PAYPAL-115 - Consolidate "Send Address" and "Override Address"
  Based on this feature, version 5.0.1 was created and replaced version 4.2.0 for ICM 7.8