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.
This delivery and the accompanying documentation are valid for the following combinations of software versions:
Intershop | Computop 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 - 7.10.30.x (Tomcat 7) | 4.7.2 |
Computop Connector version 5.0.0 features the same functionality as Computop Connector 4.7.2 to facilitate migration from ICM 7.10.30 - to 7.10.31+.
The package includes the following cartridges:
The Computop Service Connector 4.5 is based on the new Payment API introduced in IS 7.6.
The Computop Service Connector can be used for the following application types:
Application Type | Application Type ID | Description |
---|---|---|
B2C WebShop | intershop.B2CResponsive | Business to Consumer Channel |
SMB WebShop | intershop.SMBResponsive | Business to Business Channel |
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.
The package is available via Intershop's Public Nexus.
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.
For details about managing assembly artifacts, see:
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:
Property | Description | Value |
---|---|---|
intershop.payment.computop.paygate | The base URL to the Computop paygate | Default value is https://www.computop-paygate.com/ |
intershop.payment.COMPUTOP_CREDITCARD.currencies | Defines 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 system | ComputopCreditCardRedirect-Success |
intershop.payment.COMPUTOP_CREDITCARD.success_b2b_pipeline | A pipeline to be called after a successful payment at the Computop system for B2B | ComputopCreditCardRedirect-SuccessB2B |
intershop.payment.COMPUTOP_CREDITCARD.failure_pipeline | A pipeline to be called after some kind of failure occurred during payment at the Computop system | ComputopCreditCardRedirect-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 B2B | ComputopCreditCardRedirect-FailureB2B |
intershop.payment.COMPUTOP_CREDITCARD.notify_pipeline | A pipeline to be called when the notification mechanism is used to communicate with Computop system | ComputopCreditCardRedirect-Notify |
intershop.payment.COMPUTOP_CREDITCARD.delayed_capture.poolsize | A number of simultaneous unprocessed delayed captures to be supported by the server | A number - default is 100000 |
intershop.payment.COMPUTOP_ALIPAY.currencies | Defines which currencies are configurable for Computop Alipay. Default: EUR, USD, CNY | Comma-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 systems | ComputopAlipayRedirect-Success |
intershop.payment.COMPUTOP_ALIPAY.failure_pipeline | A pipeline to be called after some kind of failure occurred during payment at the Computop or Alipay systems | ComputopAlipayRedirect-Failure |
intershop.payment.COMPUTOP_ALIPAY.notify_pipeline | A pipeline to be called when the notification mechanism is used to communicate with Computop or Alipay systems | ComputopAlipayRedirect-Notify |
intershop.payment.COMPUTOP_PAYPAL.success_pipeline | A pipeline to be called after a successful payment at the Computop or PayPal systems | ComputopPayPalRedirect-Success |
intershop.payment.COMPUTOP_PAYPAL.failure_pipeline | A pipeline to be called after some kind of failure occurred during payment at the Computop or PayPal systems | ComputopPayPalRedirect-Failure |
intershop.payment.COMPUTOP_PAYPAL.notify_pipeline | A 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_pipeline | A pipeline to be called after a successful payment at the Computop or PayPal systems | ComputopPayPalExpressFastCheckout-Success |
intershop.payment.COMPUTOP_PAYPAL_EXPRESS.failure_pipeline | A pipeline to be called after some kind of failure occurred during payment at the Computop or PayPal systems | ComputopPayPalExpressFastCheckout-Failure |
intershop.payment.COMPUTOP_PAYPAL_EXPRESS.notify_pipeline | A pipeline to be called when the notification mechanism is used to communicate with Computop or PayPal systems | ComputopPayPalExpressFastCheckout-Notify |
intershop.payment.COMPUTOP_CHINAPAY.currencies | Defines 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 systems | ComputopChinaPayRedirect-Success |
intershop.payment.COMPUTOP_CHINAPAY.failure_pipeline | A pipeline to be called after some kind of failure occurred during payment at the Computop or ChinaPay systems | ComputopChinaPayRedirect-Failure |
intershop.payment.COMPUTOP_CHINAPAY.notify_pipeline | A pipeline to be called when the notification mechanism is used to communicate with Computop or ChinaPay systems | ComputopChinaPayRedirect-Notify |
intershop.payment.COMPUTOP_GIROPAY.currencies | Defines which currencies are configurable for Computop giropay. Default: EUR, USD, CNY | Comma-separated list, e.g., EUR, USD, CNY |
intershop.payment.COMPUTOP_Giropay.success_pipeline | A pipeline to be called after a successful payment at the Computop or giropay systems | ComputopGiropayRedirect-Success |
intershop.payment.COMPUTOP_Giropay.failure_pipeline | A pipeline to be called after some kind of failure occurred during payment at the Computop or giropay systems | ComputopGiropayRedirect-Failure |
intershop.payment.COMPUTOP_Giropay.notify_pipeline | A pipeline to be called when the notification mechanism is used to communicate with Computop or giropay systems | ComputopGiropayRedirect-Notify |
intershop.payment.COMPUTOP_DIRECT_DEBIT.currencies | Defines which currencies are configurable for Computop Direct Debit. Default: EUR | Comma-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.
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.
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):
Create a new class:
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.
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);
Define this custom Guice Module as global.overrideModules
in the associated resources file as described in Concept - Dependency Injection and ObjectGraphs.
This section outlines the required post-deployment configuration steps, including
Adjust your firewall settings to allow bidirectional HTTP and HTTPS traffic between the Intershop 7 and Computop systems.
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.
Explanation | Image |
---|---|
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 6. Click Enable. |
Explanation | Image |
---|---|
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 16. Click Finish. |
The table below lists Computop-specific settings for configuring the payment service.
Name | Payment Service | Description |
---|---|---|
Merchant ID | All | The merchant account's merchant ID as provided by Computop |
Merchant Code | All | The merchant account's merchant code as provided by Computop |
HMAC Code | All | The 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 Minutes | Credit Card | When using Timed Capture, you may specify a delay in minutes after which the payment is captured |
Zones | Credit Card | This 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 Zones | Credit Card | This 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 Name | All | This name is displayed in the storefront. |
Order Description | All | This description will be submitted to Computop. |
XSLT Template Path | Credit Card | Path to an XSLT template on the Computop server. |
PCN | Credit Card | Store Pseudo Card Number generated by Computop at customer's profile. |
Note
Configuring payment methods in a sales channel requires the access privilege Payment Manager for this channel.
Explanation | Image |
---|---|
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 11. Click Enable. | |
12. Go to the Payment Costs tab. 13. Define taxation class, currency, minimum order value, amount 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. |
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:
The Computop service connector adds the following payment methods to your Intershop 7 system:
Name | Description | Payment 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 Debit | Payment with Direct Debit via Computop | Authorize Capture* Cancel* Refund |
giropay | Payment with giropay via Computop | Capturing Authorization Refund |
PayPal Standard | Payment with PayPal via Computop | Capture* Cancel* Refund |
PayPal Express | Payment 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.
Operation | Description |
---|---|
Capture | Request for settling the payment |
Cancel | Request for abandoning a payment settlement |
Refund | Option to return (parts of) the captured amount |
The following table describes transmitted data by the Computop Service Connector from ICM to Computop during the payment process:
Description | Payone Payment Methods | |||||||
---|---|---|---|---|---|---|---|---|
Paypal Standard | Paypal Express | Giropay | Credit Card | Direct Debit | Alipay | Chinapay | ||
Amount | The amount for the transaction | |||||||
Currency | currency code e.g. EUR/USD | |||||||
Order Number | Order reference generated by merchant | |||||||
Order Desc | Order description | |||||||
Address | Invoice and shipping address details provided by the user (value is optional and configurable at back office) | |||||||
Order ID | Order reference generated by the merchant ICM | |||||||
Customer Info | Buyer related data B2C: firstname, lastname and e-mail B2B: company name and e-mail | |||||||
Credit Card details | Credit card brand, Credit card expiry Sensitive data is handled via PayGate iframes only and is never stored at the merchant. | |||||||
language (locale Code) | Language indicator to specify the language that should be presented to the customer | |||||||
IBAN | International bank account number | |||||||
BIC | Bank identifier code to be used for payment | |||||||
accOwner | Account owner | |||||||
accBank | Account bank | |||||||
refNr | Reference number for direct debit transaction | |||||||
dtOfSgntr | Date of signature |
Symbol | Description |
---|---|
Transmitted | |
Not Transmitted | |
Optional - Back Office Configurable |
PayPal is not available for baskets with multiple shipping buckets.
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.
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.
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.