Configuring the Paymentech plug-in

The Paymentech plug-in allows the Payment plug-in controller to communicate directly with the Paymentech gateway using the plug-in.

About this task

Follow this procedure to enable the Paymentech plugin with HCL Commerce.


  1. Follow the directions provided by Paymentech to set up network connection between HCL Commerce and the Paymentech gateway.
  2. Configure a merchant for the store.
  3. Schedule Paymentech jobs.
  4. Configure payment methods in the PaymentMethodConfigurations XML file.
    For example:
  5. Configure payment rules and payment mappings in the PaymentMappings XML file.
    For example:
    <Mapping paymentMethod="VISA" 
    paymentActionRule="Early Approval"/>
  6. Configure settings in the RefundMethodConfigurations XML file.
    For example:
    paymentSystemName="Paymentech" />
  7. Configure refund methods in the RefundMappings XML file. For example:
    <RefundMapping refundMethod="VISA" refundConfiguration="CreditCardOnline"/>
  8. Configure the PaymentSystemPluginMapping XML file to specify Paymentech.
    For example:
    <PaymentSystemName name="Paymentech" >
    <Mapping paymentConfigurationId="default" pluginName="PaymentechPlugin" >
    <!-- ====================================================================================================
    <name> The name of the plug-in property that should be used in transactions for this particular payment method. 
    A plug-in can require additional parameters, or a payment configuration can have unique needs. 
    <value> The value of the named plug-in property.
    ==================================================================================================== -->
    <Property name="SupportsOnlineTransaction" value="yes"/>
    <Keyword name="cc_cvc" mask ="-" plain="0" removeAfterApproval ="true"/>
    <Keyword name="cc_nameoncard" mask ="*" plain="0" removeAfterApproval ="true"/>
    <Keyword name="account" mask ="*" plain="-5" searchable="true"/>
  9. Set Paymentech parameters.
    1. Open the file workspace_dir/WC/xml/config/payments/ppc/plugins/PaymentechPlugin/PluginDeployment.xml
    2. Set the minBatchSize.
      For example:
      <PluginProperty name="minBatchSize" value="1"/>

      minBatchSize represents the minimum number of transactions in a batch. When the scheduler processes the job, if the number of deposit or credit transactions is less than the minBatchSize, the scheduler will not run the job. If the number of deposit or credit transactions is equal to or more than the minBatchSize, then a batch is created and processed.

    3. Set the RFRDelayTime, for example:
      <PluginProperty name="RFRDelayTime" value="1"/>

      RFRDelayTime is the delay time between the batch request sent to Paymentech and the RFR (Request For Response) sent to Paymentech to receive a batch response. The recommended value is 15.

    4. Change the IP address to connect to the Paymentech gateway.
      For example:
      <PluginProperty name="onlineHost" value=""/>
       <PluginProperty name="onlinePort" value="8526"/>
       <PluginProperty name="batchHost" value=""/>
       <PluginProperty name="batchPort" value="8527"/>
       <PluginProperty name="doDNSLookup" value="false"/>
  10. Create a partial ZIP file that contains the changed files using the same structure as the EAR file. For example:
    • xml/config/payments/edp/groups/default/PaymentMappings.xml
    • xml/config/payments/edp/groups/default/PaymentMethodConfigurations.xml
    • xml/config/payments/edp/groups/default/RefundMappings.xml
    • xml/config/payments/edp/groups/default/RefundMethodConfigurations.xml
    • xml/config/payments/ppc/plugins/PaymentSystemPluginMapping.xml
    • xml/config/payments/edp/groups/default/PaymentMethodConfigurations.xml
    • xml/config/payments/ppc/plugins/PaymentechPlugin/PluginDeployment.xml