Advanced orders Payment configuration IDs

A payment method configuration consists of the following:

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:

A payment configuration ID is tied to only one payment method. A store can use one or more configurations by having an association with those configuration IDs. If multiple stores require the same exact payment configurations, they can all be associated with the same payment configuration IDs.

Available configurations

WebSphere Commerce provides a unique 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 these available configurations as they exist or create new ones by using the Site WebSphere Commerce Administration Console. When a new configuration is created, it is made from one of the existing configuration template files which are found in the following read-only directory:

Default configurations

A payment configuration ID value is required for a store to process event-driven payments, 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 is used when:

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 read-only subdirectory: xml/config/payments/edp/defaultCfgs/payment and xml/config/payments/edp/defaultCfgs/refund.

Working with configurations

You can expect to use two different consoles to work with payment and refund configurations:

For instructions on how to perform these tasks, see the topic Defining a payment configuration for event-driven payments.

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'

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) or for a particular contract (potentially, the default contract).

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: Event-driven payments snippets.

Feedback