Defined payment business policy properties

Payment business policy properties are attributes which describe a payment business policy. You can also use the attributes to control business logic.

Defined properties Description
profileName Case-sensitive name of the Cashier profile XML file without the .profile suffix. This property is mandatory for a Commerce Payments-based payment policy.
cassetteName Case-sensitive name of the cassette. This property is mandatory for a Commerce Payments-based payment policy. The property must match the value for the PAYMENTTYPE parameter in the Cashier profile specified with the profileName property.
offlineMethod Case-sensitive name of the offline payment method. This property is mandatory for payment policy using the CustomOffline cassette. The property must match the value for the $METHOD parameter in the Cashier profile specified with the profileName property.
currencyAllowed This property indicates to the business logic that the payment policy is restricted to a certain currency. Specify the alphabetic currency code as per ISO 4217.
attrPageName Case-sensitive name of the snippet file (without the .jsp suffix) used to generate an HTML page to prompt the user for payment attributes or parameter required by the payment policy. This page is called the Payment Attribute Page and this property is used by the WebSphere Commerce Accelerator.

You can find examples of payment attribute pages in the WC_installdir/wc.ear/wctools.war/order/buyPages directory.

excludeFrom The only recognized value is defaultTC. This indicates to the business logic that the payment policy should be excluded from the list of allowable payment policies when the trading agreement does not contain payment terms and conditions.

The UsablePaymentTCListDataBean and PaymentPolicyListDataBean use this property to filter out certain payment policies from a prepared list. For example, if a particular payment policy has this property and the caller of the DataBean is requesting a list of all usable PaymentTCInfo or PaymentPolicyInfo and there is no payment terms and conditions or only the default trading agreement is present, this payment policy would be excluded from the list returned.

The property requireExplicitTC=true implies excludeFrom=defaultTC. However, both may be specified to make the intention clear.

requireExplicitTC This property indicates to the business logic that the payment policy requires an explicit payment terms and conditions. For example, the payment policy cannot be used without a payment terms and conditions that specifies the policy. Specifies true or false (the default).

This property governs whether a particular payment policy can be used to purchase an order item that does not have a trading agreement with a specified payment terms and conditions if other order items within the order have trading agreements that include payment terms and conditions with this policy. If requireExplicitTC=true, then the policy cannot be used for the order items without payment terms and conditions.

This property implies excludeFrom=defaultTC.