Configuring the WCPayments plug-in

Use the WCPayments plug-in as a bridge from the WebSphere Commerce Payments Multipayment Framework using cassettes. If you are interested in using an offline payment mechanism, use the SimpleOffline plug-in instead.


  1. Configure at least one cassette.
  2. Configure the payment system mapping. The following example shows the WCPayments plug-in is configured with BankServ payment system (the Cassette for BankServACH).
      <PaymentSystemName name="BankServ" >
                    PluginName="WCPaymentsPlugin" >
                 <Property name="ProfileName" value="WCPPlugin_BankServACH"/>
                 <Property name="SupportsOnlineTransaction" value="yes"/>
    The short form of the name of the Cashier profile.
    • BankServACH profile - WCPPlugin_BankServACH
    • CustomOffline COD.profile - WCPPlugin_CustomOffline_COD
    • CustomOffline BillMe.profile - WCPPlugin_CustomOffline_BillMe
    • OfflineCard cassette profile - WCPPlugin_OfflineCard
    • Paymentech profile - WCPPlugin_Paymentech
    • VisaNet profile for regular credit cards - WCPPlugin_VisaNet
    Indicates that payment actions will be processed online.
    Payment actions will be set as PENDING after the WebSphere Commerce Payments and theWCPayments plug-in process the offline transaction. After a manual action is taken to process the payment (such as approving the payment using the WebSphere Commerce Payments administration GUI), the WCPayments plug-in can issue a query to synchronize the transactions. When the Payment rules engine queries a payment or a credit, the payment or credit will be synchronized with the payment back-end system. If you are using the OfflineCard or CustomOffline payment cassettes, this value should be 'no'.
  3. Configure payment methods.
    1. In a text editor or XML editor, open your copy of the PaymentSystemPluginMapping XML file.
    2. Specify the payment system name, payment configuration ID, plug-in name, and any specific plug-in properties that should be used for that payment system name mapping.

      Since a plug-in can be associated with more than one payment system name, you can specify properties that are unique to a particular payment system name. For example, PaymentSystemName ABC can use property XXX, and PaymentSystemName DEF can use property YYY even though the same plug-in is used for both.

      When the payment system name is used, the set of properties defined in the PaymentSystemPluginMapping.xml file is applied. These properties are different from the plug-in properties specified in the deployment descriptor. The properties specified in the deployment descriptor apply to the plug-in itself and remain constant in memory as the plug-in is used, regardless of the payment system name being used.

    3. Save the file.
  4. Configure refund methods.
    1. In a text editor or XML editor, open the RefundMethodConfigurations XML file which is in the following directory:
      • WC_eardir/xml/config/payments/edp/groups/default
      • WebSphere Commerce Developerworkspace_dir/wc/xml/config/payments/edp/groups/default
    2. Specify a configuration for the refund method. Supply values for the following parameters:
      • refund method
      • paymentSystemName
      Refer to the description of the file for more information about these parameters. Multiple refund methods can be configured in this file.
    3. Save the file.
  5. Modify the WCPayments plug-in deployment descriptor (PluginDeployment.xml) file to set the connection parameters, including the host name (WebSphere Commerce Payments Web server) and port. For instructions, see the topic .
  6. Package your assets as a partial application.
  7. Deploy the changed assets.
  8. Ensure that WebSphere Commerce Payments is started.