PaymentMethodConfigurations XML file

Use the PaymentMethodConfigurations.xml file to configure the payment method details.

This file is located in the following directory:

  • AIXLinuxWindowsworkspace_dir/WC/xml/config/payments/edp/groups/default
  • HCL Commerce Developerworkspace_dir/wc/xml/config/payments/edp/groups/default

The configuration details include the following information:

  • Payment method to which the configuration applies
  • Name of the payment system that will process the payment requests.
  • Other configuration properties for the payment method, such as:
    • Whether a payment amount can be changed by the system or a person.
    • Whether refunds are allowed if the payment method is used for the order.
    • Whether minimum or maximum amounts for the payment. If no maximum payment amount should exist, the maximum amount is Unbounded.
    • What priority the payment method should have in situations where multiple payment methods are used.

This file should contain only one payment method configuration.


<?xml version="1.0" encoding="UTF-8"?>
<PaymentMethodConfigurations
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="com/ibm/commerce/edp/parsers/PaymentMethodConfigurations.xsd">
      <PaymentMethodConfiguration
                    name="CreditCardOffline"
                    paymentSystemName="OfflineCreditCardSystem"
                    systemEditable="true"
                    humanEditable="true"
                    refundAllowed="true"
                    minimumAmount="0"
                    maximumAmount="Unbounded"
                    priority="MEDIUM"
                    partiallyConsumable="true"
                    dependentCreditRequired="false"/>
     </PaymentMethodConfiguration>
</PaymentMethodConfigurations>  
Figure 1: Example 2: Electronic check configuration

<?xml version="1.0" encoding="UTF-8"?>
<PaymentMethodConfigurations
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="com/ibm/commerce/edp/parsers/PaymentMethodConfigurations.xsd">

     
     <PaymentMethodConfiguration
                    name="CheckOffline"
                    paymentSystemName="OfflineACHSystem"
                    systemEditable="false"
                    humanEditable="false"
                    refundAllowed="false"
                    minimumAmount="0"
                    maximumAmount="Unbounded"
                    priority="LOW"
                    dependentCreditRequired="false"
                    partiallyConsumable="false"/>
     </PaymentMethodConfiguration>  
</PaymentMethodConfigurations>
Parameters
name
The name of the payment configuration.
paymentSystemName
The name of the payment back-end system. The payment system name should be consistent with a payment system name in the PaymentSystemPluginMapping.xml file.
systemEditable
Indicates whether the Payment rules engine can increase the amount, if required, of a payment to be processed using that payment method. For instance, an order amount might increase from $100.00 to $105.00 US dollars when shipping and handling charges are added. In the first example, when systemEditable="true", the Payment rules engine will not reject the request when a credit card is used to pay for the order.
humanEditable
Indicates whether a customer or service representative can increase the amount for a payment method during an edit operation. For example, amounts can be increased for credit cards, but once a check is written, the check amount cannot be increased.
refundAllowed
Specifies whether a refund can be issued for an order that has used this payment method (true or false).
minimumAmount
The minimumAmount specifies the lower limit of a payment method in situations where minimum limits must be imposed. For example, some merchants might want to restrict the use of credit cards with high processing fees by setting minimum payments for those cards when used.
maximumAmount
The maximumAmount specifies the upper limit of a payment method. For example, some merchants might want to restrict that only gift certificates up to 20 USD can be used. If no maximum payment amount should exist, the maximum amount is Unbounded.
priority
Specifies the priority of the consumption of the payment method when more than one payment method is used as payment (for example, a customer pays with both a gift certificate and credit card). Typical values are:
  • Cash on delivery (COD) - LOW
  • Bill me - MEDIUM
  • Credit card - MEDIUM
  • Check - HIGH
  • Gift certificate - HIGH
partiallyConsumable
Indicates whether the payment method can be used up partially or not (true or false). This element is associated with the use of the credit cards or the gift certificate payment method. If the payment method must be consumed or redeemed entirely rather than in increments (such as with checks), specify "false."
dependentCreditRequired
Indicates whether credit transactions against this payment method require dependent credit or not (true or false). The default value, false, means that independent credit is supported by the payment method.