Advanced orders PaymentMethodConfiguration XML file

Use the PaymentMethodConfiguration.XML file to configure the payment method details for event-driven payments. This file is located in the following directory:

The configuration details include the following information:

These configurations are internal and are not seen by customers.

This file should contain only one payment method configuration.

Example 1: Credit card configuration
<?xml version="1.0" encoding="UTF-8"?>
<PaymentMethodConfiguration
     xmlns:xsi="http://www.w3.org.2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="com/ibm/edp/parsers/PaymentMethodConfigurations.xsd">
     
     <PaymentMethodConfiguration
                    paymentMethod="AMEX"
                    paymentRule="Early Validation" 
                    paymentSystemName="OfflineCreditCardSystem"
                    systemEditable="true"
                    humanEditable="true"
                    refundAllowed="true"
                    minimumAmount="0"
                    maximumAmount="Unbounded"
                    priority="MEDIUM"
                    partiallyConsumable="true"/>
     </PaymentMethodConfiguration>     

Example 2: Electronic check configuration

<?xml version="1.0" encoding="UTF-8"?>
<PaymentMethodConfiguration
     xmlns:xsi="http://www.w3.org.2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="com/ibm/edp/parsers/PaymentMethodConfigurations.xsd">
     
     <PaymentMethodConfiguration
                    paymentMethod="Check"
                    paymentRule="Early Deposit" 
                    paymentSystemName="OfflineACHSystem"
                    systemEditable="false"
                    humanEditable="false"
                    refundAllowed="false"
                    minimumAmount="0"
                    maximumAmount="Unbounded"
                    priority="LOW"
                    partiallyConsumable="false"/>
     </PaymentMethodConfiguration>     

Use the following parameters to change the behavior of event-driven payments:

paymentMethod
The name of the payment method.
paymentRule
The name of the payment rule to be used with this payment method. Payment rules are defined in the PaymentRules.xml file.
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 event-driven payments service is allowed to 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/handling charges are added. In the first example, when systemEditable="true", the event-driven payments service 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.
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.
refundAllowed
Specifies whether a refund can be issued for an order that has used this payment method (true or false).
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). Values are: HIGH, MEDIUM, and LOW. Typical values are:
  • Bill me - MEDIUM
  • Cash on delivery (COD) - LOW
  • Check - HIGH
  • Credit card - MEDIUM
  • 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."

Feedback