Configure the SimpleOffline plug-in

Use the SimpleOffline plug-in to process payment transactions manually. WebSphere Commerce tracks the payment status of the order.


Task info

Since there is no direct communication with a payment back-end system with the SimpleOffline plug-in, this plug-in does not require registration with a payment service provider for operation.


Procedure

  1. Map the plug-in to the payment system and payment configuration. For example: 

         <PaymentSystemName
          name="OfflineCard" >
          <Mapping 
                paymentConfigurationId="default"
                PluginName="SimpleOffline" >
          </Mapping>
    </PaymentSystemName>

    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, we 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.

  2. Configure payment methods.

    1. In a text editor or XML editor, open the PaymentMethodConfigurations XML file which is in the following directory:

    2. Specify a configuration for the payment method. Supply values for the following parameters:

      • payment method

      • paymentRule

      • paymentSystemName

      • systemEditable

      • humanEditable

      • refundAllowed

      • minimumAmount

      • maximumAmount

      • priority

      • dependentCreditRequired

      Refer to the description of the file for more information about these parameters. Multiple payment methods can be configured in this file.

    3. Save the file.

  3. Configure refund methods.

    1. In a text editor or XML editor, open the RefundMethodConfigurations XML file which is in the following directory:

    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.

  4. Configure pending state. Open the SimpleOfflinePlugin.xml file. Set values for the PaymentConfiguration and keepPendingStatus.

  5. Optional: If you require the SimpleOffline plug-in to support a new payment method, we must include the corresponding JSP snippets in the storefront page to collect the required protocol data for the new payment method. No JSP snippets are required by the SimpleOffline plug-in if we are using the predefined payment methods. See Sample: Payment method JSP snippets.

  6. Update for v9.

  7. Update for v9.


Related concepts
SimpleOffline plug-in


Related reference
SimpleOffline plug-in financial transactions
SimpleOfflinePlugin.xml