Administer > Manage WebSphere Commerce features > Payments subsystem > Configure payment plug-ins

Configure a custom payment plug-in

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

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, refer to the Payment plug-in specification.

To use the address information entered by customers, ensure that the address parameters (keywords or name-value pairs) as provided in WebSphere Commerce match the requirements of both the payment plug-in and any payment back-end system the plug-in communicates with. Address information requirements can vary by geography 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


  1. When configuring the payment methods and refund methods the store will use, be sure to 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 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.

  4. Restart WebSphere Commerce .


After completing these tasks, the store should be able to process payment transactions using the payment plug-in.

Related reference

PaymentMappings XML file

PaymentMethodConfigurations XML file

RefundMethodConfigurations XML file


Search Tips   |   Advanced Search