Payment configuration IDs
A payment method configuration consists of the following:
- The payment business policy (or refund business policy) in the POLICY database table. Payment business policies have the policy type "Payment." Refund business policies have the policy type "ReturnPayment."
- XML files for Payment Rules
- XML files for the WebSphere Commerce Payments
A payment (or refund) method configuration is uniquely identified by a payment configuration ID. A payment configuration ID is the mechanism by which the payment subsystem can identify the particular set of configuration files to use for a given payment method. It is a string value that represents the folder or directory name under which a particular set of XML configuration files resides. A payment configuration ID is:
- Used as a property in the POLICY table for payment and refund business policies
- A directory containing XML files for Payment Rules
- An XML element identifier for the WebSphere Commerce Payments
Only one payment configuration ID is configured to one payment method in the POLICY table. A store can use one or more configurations by associating different payment methods with different configuration IDs. If multiple stores require the same exact payment configurations, their payment methods can all be associated with the same payment configuration IDs.
Available configurations
WebSphere Commerce provides a default configuration ID for every payment method it initially supports (for example, for brands of credit cards, check, COD, Bill Me Later, and line of credit). You can use this configuration as it exists or create new ones manually. When a new configuration is created, it is be copied from the pre-built default payment configuration:
WC_eardir/xml/config/payments/edp/groups/default
WCDE_installdir/xml/config/payments/edp/groups/default
Default configuration
A payment configuration ID value is required for a store to process Payment Rules, even if you are configuring payment processing for only one store. If payment processing is attempted for an order and there is no payment configuration ID associated with the store, WebSphere Commerce uses a default configuration for the payment method. The "default" payment configuration ID refers to a directory with default payment method configurations.
A default configuration uses the payment configuration ID value of "default." Payment configurations you create should not contain the "default" value.
Important! Payment methods will not display in the starter stores if no payment configuration IDs exist in the POLICY table.
Default configurations are located in the following subdirectory: xml/config/payments/edp/groups/default
Relationship with POLICY table
A store is associated with a payment configuration ID through a payment business policy. When a payment or refund method configuration is added to a store, a new entry is made in the POLICY table. For example:
| Store ID | Policy ID | Business policy name | Business policy type | Properties |
|---|---|---|---|---|
| 12345 | -1237 | Visa | Payment | paymentConfigurationId=value attrPageName=JSP_snippet_name display=true compatibleMode=false |
The payment configuration ID can be viewed in the POLICY database table through a property called paymentConfigurationId. The payment business policy defines the payment methods that are accepted for a particular store (or for all stores), the default value is "default".
The system ensures that a POLICY entry exists and matches the payment method. In the POLICY table, the payment method corresponds to the policy name. A payment configuration is made unique through its policy name (the policy name is contained in the POLICYDESC table).
A payment business policy property called attrPageName identifies the name of the JSP snippet file (without the .jsp suffix) that is used to generate an HTML page to prompt the user for the payment attributes or parameters required by the payment policy. JSP snippets are available for processing standard credit card brands and other payment methods. For more information, see the topic Sample: Payment Rules JSP snippets. There is no default value for this property.
The payment business policy property called display identifies whether or not the payment method should be displayed at the store front for the the shopper to use. You can change this flag to "false" if you don't want the shoppers to use this payment method temporarily. The default value is "true".
The payment business policy property called compatibleMode identifies whether this payment method is just for compatibility. The payment method with compatibleMode=true will not use the new infrastructure of WebSphere Commerce Payments component for payment plug-ins. The default value is "false" to keep the compatibility.
(C) Copyright IBM Corporation 1996, 2006. All Rights Reserved.