Public Release Note - Computop Service Connector 4

1 Introduction

Welcome to the Intershop Computop Service Connector. The service connector adds Computop payment methods to your Intershop installation.

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

1.1 References

1.2 Version Information and Dependencies

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

IntershopComputop Service Connector

7.6.2.5+

4.5.1

7.7.5.17+

7.8.4.0+

7.9.4.5+

7.10.15.3+

4.7.1



4.7.2

The package includes the following cartridges:

  • ac_payment_computop

The Computop Service Connector 4.5 is based on the new Payment API introduced in IS 7.6.

1.3 Supported Application Types

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

Application TypeApplication Type IDDescription
B2C WebShopintershop.B2CResponsiveBusiness to Consumer Channel
SMB WebShopintershop.SMBResponsiveBusiness to Business Channel

2 Setup

This section outlines the basic setup and configuration steps, including

Note

Managing and deploying the Computop Service Connector requires a continuous integration environment set up and configured as described in Cookbook - Setup CI Infrastructure.

2.1 Precondition

The package is available via Intershop's Public Nexus.

  • A set up and configured CI environment
    See Cookbook - Setup CI Infrastructure for details.
    See Concept - Continuous Delivery Tools for basic information about Continuous Integration.
  • A running Intershop Commerce Management 7.6, 7.7, 7.8, 7.9, 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

2.2 Set Up the Assembly

To add the Computop Service Connector into your Intershop 7 system, there are two options:

  • Incorporating the cartridge into an already existing assembly in the build.gradle file of the assembly. To do so, add:

    cartridges {     
            def computopPaymentProvider = [
                'ac_payment_computop'
            ]
            include (*(computopPaymentProvider.collect {"com.intershop.services.payment_computop:$it:4.7.2"}), in: [development, test, production]) 
    ...
            order = listFromAssembly(<yourAssembly>) + computopPaymentProvider
    }

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

  • Alternatively, you can create a new assembly inheriting from an Intershop CM 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:

2.3 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 Computop Service Connector.

The Computop Service Connector requires the following settings:

PropertyDescriptionValue
intershop.payment.computop.paygateThe base URL to the Computop paygateDefault value is https://www.computop-paygate.com/
intershop.payment.COMPUTOP_CREDITCARD.currenciesDefines which currencies are configurable for Computop Credit Card. Default: * (all currencies)Comma-separated list, e.g., EUR, USD

intershop.payment.COMPUTOP_CREDITCARD.success_pipeline

A pipeline to be called after a successful payment at the Computop systemComputopCreditCardRedirect-Success

intershop.payment.COMPUTOP_CREDITCARD.success_b2b_pipeline

A pipeline to be called after a successful payment at the Computop system for B2BComputopCreditCardRedirect-SuccessB2B

intershop.payment.COMPUTOP_CREDITCARD.failure_pipeline

A pipeline to be called after some kind of failure occurred during payment at the Computop systemComputopCreditCardRedirect-Failure

intershop.payment.COMPUTOP_CREDITCARD.failure_b2b_pipeline

A pipeline to be called after some kind of failure occurred during payment at the Computop system for B2BComputopCreditCardRedirect-FailureB2B
intershop.payment.COMPUTOP_CREDITCARD.notify_pipelineA pipeline to be called when the notification mechanism is used to communicate with Computop systemComputopCreditCardRedirect-Notify
intershop.payment.COMPUTOP_CREDITCARD.delayed_capture.poolsizeA number of simultaneous unprocessed delayed captures to be supported by the serverA number - default is 100000
intershop.payment.COMPUTOP_ALIPAY.currenciesDefines which currencies are configurable for Computop Alipay. Default: EUR, USD, CNYComma-separated list, e.g., EUR, USD

intershop.payment.COMPUTOP_ALIPAY.success_pipeline

A pipeline to be called after a successful payment at the Computop or Alipay systemsComputopAlipayRedirect-Success
intershop.payment.COMPUTOP_ALIPAY.failure_pipelineA pipeline to be called after some kind of failure occurred during payment at the Computop or Alipay systemsComputopAlipayRedirect-Failure
intershop.payment.COMPUTOP_ALIPAY.notify_pipelineA pipeline to be called when the notification mechanism is used to communicate with Computop or Alipay systemsComputopAlipayRedirect-Notify
intershop.payment.COMPUTOP_PAYPAL.success_pipelineA pipeline to be called after a successful payment at the Computop or PayPal systemsComputopPayPalRedirect-Success
intershop.payment.COMPUTOP_PAYPAL.failure_pipelineA pipeline to be called after some kind of failure occurred during payment at the Computop or PayPal systemsComputopPayPalRedirect-Failure
intershop.payment.COMPUTOP_PAYPAL.notify_pipelineA pipeline to be called when the notification mechanism is used to communicate with Computop or PayPal systems

ComputopPayPalRedirect-Notify

intershop.payment.COMPUTOP_PAYPAL_EXPRESS.success_pipelineA pipeline to be called after a successful payment at the Computop or PayPal systemsComputopPayPalExpressFastCheckout-Success
intershop.payment.COMPUTOP_PAYPAL_EXPRESS.failure_pipelineA pipeline to be called after some kind of failure occurred during payment at the Computop or PayPal systemsComputopPayPalExpressFastCheckout-Failure
intershop.payment.COMPUTOP_PAYPAL_EXPRESS.notify_pipelineA pipeline to be called when the notification mechanism is used to communicate with Computop or PayPal systemsComputopPayPalExpressFastCheckout-Notify
intershop.payment.COMPUTOP_CHINAPAY.currenciesDefines which currencies are configurable for Computop ChinaPay. Default: CNY. For the usage of ChinaPay, CNY is mandatory.Comma-separated list, e.g., CNY

intershop.payment.COMPUTOP_CHINAPAY.success_pipeline

A pipeline to be called after a successful payment at the Computop or ChinaPay systemsComputopChinaPayRedirect-Success
intershop.payment.COMPUTOP_CHINAPAY.failure_pipelineA pipeline to be called after some kind of failure occurred during payment at the Computop or ChinaPay systemsComputopChinaPayRedirect-Failure
intershop.payment.COMPUTOP_CHINAPAY.notify_pipelineA pipeline to be called when the notification mechanism is used to communicate with Computop or ChinaPay systemsComputopChinaPayRedirect-Notify
intershop.payment.COMPUTOP_GIROPAY.currenciesDefines which currencies are configurable for Computop giropay. Default: EUR, USD, CNYComma-separated list, e.g., EUR, USD, CNY
intershop.payment.COMPUTOP_Giropay.success_pipelineA pipeline to be called after a successful payment at the Computop or giropay systemsComputopGiropayRedirect-Success
intershop.payment.COMPUTOP_Giropay.failure_pipelineA pipeline to be called after some kind of failure occurred during payment at the Computop or giropay systemsComputopGiropayRedirect-Failure
intershop.payment.COMPUTOP_Giropay.notify_pipelineA pipeline to be called when the notification mechanism is used to communicate with Computop or giropay systemsComputopGiropayRedirect-Notify
intershop.payment.COMPUTOP_DIRECT_DEBIT.currenciesDefines which currencies are configurable for Computop Direct Debit. Default: EURComma-separated list, e.g., EUR

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

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

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

Note

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

3 Customization

3.1 Change the Values of Parameters Sent to Computop

Since version 4.4.1 of the connector it is possible to modify the values of some of the parameters sent to Computop. Those parameters are TransID, RefNr, PayID and ReqID.

To provide custom values of those parameters in one of the payment methods (e.g., Alipay), you need to create a new class:

CustomAlipayRequestParamsProvider
public class CustomAlipayRequestParamsProvider implements Function<RequestParamContext, String>
{
    @Override
    public String apply(RequestParamContext paramContext)
    {
		switch(paramContext.getParamName())
        {
            case "RefNr": ...
			...
			default: return null;
		}
    }
}

You retrieve the parameter name from the RequestParamContext class. This class also provides the current Payable and PaymentContext objects, which could help you generate a value for the parameter.

If you wish to provide values only for a subset of the 4 supported parameters, return null for the rest - this way the default to the connector value will be used.

Then you need to bind your class in a custom Guice Module. In this case something like this:

bind(new TypeLiteral<Function<RequestParamContext, String>>()
{
}).annotatedWith(AlipayRequestParamsProvidier.class.getAnnotation(Named.class))
             .to(CustomAlipayRequestParamsProvider.class).in(Singleton.class);

4 Configuration

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

4.1 Adjusting Firewall Settings

Adjust your firewall settings to allow bidirectional HTTP and HTTPS traffic between the Intershop 7 and Computop systems.

4.2 Applying UI-Based Configuration

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

For details about enabling a payment service, see - Recipe: Enable a Payment Service.

4.2.1 Assign Payment Services to a Sales Organization

ExplanationImage

Log in to Organization Management.

1. Navigate to Sales Organizations.

2. Select the name of the organization.

3. Go to the Services tab.

4. Click Payment Services.


5. Select the checkboxes of the new payment methods
you intend to enable for the current sales organization.

6. Click Enable.

4.2.2 Create a Managed Payment Service

ExplanationImage

Log in to Commerce Management.

1. Select the Organization/Channel.

2. Go to Services.

3. Click New.

4. Select the new payment service.

5. Click Next.

6. Enter a Payment Service Name.

7. Enter "Service ID".

8. Select the checkbox for Active.

9. Select the checkbox for Available.

10. Click Next.

11. Enter all Computop general settings.

12. Enter all logging settings.

13. Enter all monitoring settings.

14. Click Next.

15. Select the Sharing Rule.

(When setting up in the organization area, the service
must necessarily be shared to the channel.)

16. Click Finish.

The table below lists Computop-specific settings for configuring the payment service.

NamePayment ServiceDescription
Merchant IDAllThe merchant account's merchant ID as provided by Computop
Merchant CodeAllThe merchant account's merchant code as provided by Computop
HMAC CodeAllThe merchant account's HMAC code as provided by Computop
Capture

Credit Card,

PayPal Standard

Capture mode (Manual, Auto, Timed). Timed is only available for Credit Card. If you use "Timed", you must set a "Capture Time in Minutes".
Capture Time in MinutesCredit CardWhen using Timed Capture, you may specify a delay in minutes after which the payment is captured
ZonesCredit CardThis describes the mode to validate clients (permit all, permit selected, forbid selected). If you use "permit selected" or "forbid selected", you must also set "Zone List (ISO 3166 Area Codes)" as a comma-separated list.
IP ZonesCredit CardThis describes the mode to validate client IPs (permit all, permit selected, forbid selected). If you use "permit selected" or "forbid selected", you must also set "IP Zone List (ISO 3166 Area Codes)" as a comma-separated list.
Storefront NameAllThis name is displayed in the storefront.
Order DescriptionAllThis description will be submitted to Computop.
XSLT Template PathCredit CardPath to an XSLT template on the Computop server.
PCNCredit CardStore Pseudo Card Number generated by Computop at customer's profile.

4.2.3 Configure the Payment Methods

Note

Configuring payment methods in a sales channel requires the access privilege Payment Manager for this channel.

ExplanationImage

Enable the payment method for the channel.

Log in to Commerce Management.

1. Select the context selection box.

2. Select the sales channel.

3. Go to Orders.

4. Go to Payment Methods.

5. Click New.

6. Enter "Payment Method ID".

7. Select the Configuration Type.

(This was created in the section Create a Managed Payment Service.)

8. Click Apply.

9. Go to the Applications tab.

10. Select the checkboxes of all applications
for which the payment method should be enabled.

11. Click Enable.

12. Go to the Payment Costs tab.

13. Define taxation class, currency, minimum order value, amount
and/or threshold for the payment method if desired and click Add.

14. Click Apply.

15. Go to the Customer Segments tab.

16. Enable the target customer segments.

17. Click Apply.


18. Go to the Preferences tab.

19. Select the currency-dependent availability and the payment currency.

20. Click Apply.


4.3 Localization

The Computop Service connector provides English and German localization files for payment-specific input field labels, error messages etc.

You can find the existing localization files here: <IS.INSTANCE.SHARE>/system/cartridges/ac_payment_computop/release/localizations.

For details about localization, see:

5 Feature Overview

5.1 Payment Methods

The Computop service connector adds the following payment methods to your Intershop 7 system:

NameDescriptionPayment Management Options


Alipay


Payment with Alipay via Computop

Capturing Authorization

Cancel**

Refund


Credit Card


Payment with credit card via Computop

Capture*

Cancel*

Refund

ChinaPay

Payment with ChinaPay via Computop

Capturing Authorization

Direct DebitPayment with Direct Debit via Computop

Authorize

Capture*

Cancel*

Refund

giropayPayment with giropay via Computop

Capturing Authorization

Refund


PayPal Standard


Payment with PayPal via Computop

Capture*

Cancel*

Refund

PayPal ExpressPayment with PayPal Express via Computop

Capture*

Cancel*

Refund

* only available if the corresponding payment method's Capture Mode is set to "manual" or "timed".

** Alipay Cancel is only available to the customer in the storefront and actually executes a full refund.

5.2 Payment Management Options

OperationDescription
CaptureRequest for settling the payment
CancelRequest for abandoning a payment settlement
RefundOption to return (parts of) the captured amount

6 Limitations

6.1 PayPal with Multiple Shipping Buckets

PayPal is not available for baskets with multiple shipping buckets.

6.2 Credit Card with Order Approval Service

Please be aware that Computop Credit Card uses redirect after checkout. Intershop's current demo shop inSPIRED does not support a redirect after checkout if an order approval service in channel type intershop.SMBResponsive is enabled.

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

6.4 Credit Card Timed Capture When Server Is Shut Down

Scheduled timed captures (with delay), which were not yet processed when the server was shut down for some reason, will not be captured automatically. These payments must be captured manually.

7 Changelog

7.1 Version COMPUTOP/4.7.2

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

7.2 Version COMPUTOP/4.7.1

  • New Feature: COMPUTOP-232 Implement 3D Secure 2.0 for Credit Card
  • Fix: COMPUTOP-228 Parameters "template" and "language" are transmitted in the unencrypted part of the redirect URL

7.3 Version COMPUTOP/4.6.3

  • Fix: COMPUTOP-215, COMPUTOP-216 Trim amounts to 2 digits behind the comma as requested by COMPUTOP

7.4 Version COMPUTOP/4.6.2

  • Fix: COMPUTOP-101 Handover of localization parameter from ICM to PSP
  • Fix: COMPUTOP-103 Missing German localization added

7.5 Version COMPUTOP/4.6.0

  • New Feature: Computop is now available for Intershop Commerce Management 7.8 and 7.9
  • New Feature: [ISPAYCON-25] - Integrate giropay and Direct Debit

7.6 Version COMPUTOP/4.5.1

  • Fix: COMPUTOP-89 - Computop Payment with Giftcards involved transfers wrong amount for authorize
  • New underlying 7.7 version: 7.7.4.9

7.7 Version COMPUTOP/4.5.0

  • New Feature: [COMPUTOP-74] - Take over PayPal Express' invoice address
  • New Feature: [COMPUTOP-82] - Provide possibility to easily override parameters sent to COMPUTOP

7.8 Version COMPUTOP/4.4.0

  • New Feature: [COMPUTOP-43] - Integrate ChinaPay
  • New Feature: Computop is now available for Intershop Commerce Management 7.8

7.9 Version COMPUTOP/4.3.1

  • New Feature: [COMPUTOP-56] - Computop PayPal Express payment method was added

7.10 Version COMPUTOP/4.2.0

  • New Feature: [COMPUTOP-55] - Computop PayPal Standard payment method was added

7.11 Version COMPUTOP/4.1.3

  • New Feature: Computop is now available for Intershop Commerce Management 7.7
  • New Feature: [COMPUTOP-1] - Add Parameter <EtiId>
  • Fix: COMPUTOP-64 - Anonimous checkout not possible with Computop Credit Card

7.12 Version COMPUTOP/4.1.1

  • New Feature: [COMPUTOP-31] - Fully migrated Computop Credit Card to the new Payment API
  • New Feature: [COMPUTOP-32] - Added Computop Alipay as additional payment method
  • Fix: COMPUTOP-60 -  Incorrect naming of the ISML extension file (this bug may influence the an assembly with multiple payment methods installed. If only Computop is installed this is not an issue)

7.13 Version COMPUTOP/4.0.2

  • Fix: ISPAY-962 - Computop Payment Log messages are missing in B2B application

7.14 Version COMPUTOP/4.0.1

  • Fix: ISPAY-934 - Computop: configuration values do not match with documentation
  • Fix: ISPAY-935 - Computop: missing return values in payment history
  • Fix: ISPAY-936 - Computop: Checkout fails with capture option "Timed"

7.15 Version COMPUTOP/4.0.0

  • [ISPAY-792] - Migrate Computop to IS 7.6

Disclaimer

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets