Configure a custom payment plug-in

Follow the same process to configure a custom plug-in as you would follow to configure a plug-in that is provided with WebSphere Commerce.


Task info

If there are special properties that apply to the plug-in, ensure that the deployment descriptor includes those properties. Properties can also be set in the PaymentSystemPluginMapping.xml file. For more information about the deployment descriptor, see Payment plug-in specification.

If we want to use the address information that is entered by customers, ensure that the address parameters (keywords or name-value pairs) as provided in WebSphere Commerce match the requirements of both your payment plug-in and any payment back-end system your plug-in communicates with. Address information requirements can vary by locale and not all payment back-end systems use the same address data. The payment plug-ins provided with WebSphere Commerce generally process commonly used address parameters


Procedure

  1. When you configure the payment and refund methods for the store, specify the payment system name associated with the plug-in you intend to use. The PaymentMethodConfigurations.xml and RefundMethodConfigurations.xml file should contain a payment system name that matches the payment system name that is known to WebSphere Commerce.

  2. Ensure the PaymentSystemMappingPlugin.xml file is configured appropriately for the plug-in.

  3. Set up the payment business policies as appropriate. See Payment, refund, and return payment business policies.


Results

Your store can process payment transactions with the payment plug-in.


Related reference
PaymentMappings XML file
PaymentMethodConfigurations XML file
RefundMethodConfigurations XML file