Defined payment business policy properties

Develop > Controller layer > Integrate with back-end systems and external applications > Customize WebSphere Commerce Payments

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 cassettes-based payment policy.
cassetteName Case-sensitive name of the cassette. This property is mandatory for a Commerce Payments cassettes-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 store front page and WebSphere Commerce Accelerator.
You can find examples of payment attribute pages in the WC_EAR/Stores.war/WebContent/store_name/Snippets/EDP/PaymentMethods or
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.
paymentConfigurationId The ID of the payment configuration. A payment configuration identifies a particular set of configurations for payment or refund method. The payment configuration that a payment or refund method uses is identified in the POLICY database table. Multiple payment configurations can be associated with a particular store by different payment or refund method. A value of "default" refers to a directory with default payment method or refund method configurations.
display This property determines whether this payment policy should be displayed to shopper in the store front or to TSR in telesales client.
Only when the display is "true", this payment method can be chosen by the shopper to pay an order. Otherwise, the payment method is hidden from the shoppers so the store can prevent any new order using this payment method.
By default, all the payment methods for the store group -1 are all set with "display=false". Every store will have a copy of any payment method it wants to use and change the display property to true.
The store creation wizard can provide the panel to copy all the available payment methods from store group -1.
When this property is not set, the default value is true to keep the compatibility.
compatibleMode This property determines whether this payment policy is compatible with payment policy commands in WebSphere Commerce v5.x.

true

Use for payment methods migrated from WebSphere Commerce v5.x.

false

The default value. Payments are processed by the Payment rules engine.

attrTelesalesPageName This policy property is used to specify the name of the Multiple Sales Center client panel to prompt the user for payment attributes or parameter required by the payment policy.
If this property is not set, the default value will be the value of property attrPageName.

Add a new payment business policy
Adding a new payment business policy involves:

Related concepts

Payment business policies

Related tasks

Add a new payment business policy

+
Search Tips | Advanced Search

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 cassettes-based payment policy.
cassetteName	Case-sensitive name of the cassette. This property is mandatory for a Commerce Payments cassettes-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 store front page and WebSphere Commerce Accelerator. You can find examples of payment attribute pages in the WC_EAR/Stores.war/WebContent/store_name/Snippets/EDP/PaymentMethods or 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.
paymentConfigurationId	The ID of the payment configuration. A payment configuration identifies a particular set of configurations for payment or refund method. The payment configuration that a payment or refund method uses is identified in the POLICY database table. Multiple payment configurations can be associated with a particular store by different payment or refund method. A value of "default" refers to a directory with default payment method or refund method configurations.
display	This property determines whether this payment policy should be displayed to shopper in the store front or to TSR in telesales client. Only when the display is "true", this payment method can be chosen by the shopper to pay an order. Otherwise, the payment method is hidden from the shoppers so the store can prevent any new order using this payment method. By default, all the payment methods for the store group -1 are all set with "display=false". Every store will have a copy of any payment method it wants to use and change the display property to true. The store creation wizard can provide the panel to copy all the available payment methods from store group -1. When this property is not set, the default value is true to keep the compatibility.
compatibleMode	This property determines whether this payment policy is compatible with payment policy commands in WebSphere Commerce v5.x. true Use for payment methods migrated from WebSphere Commerce v5.x. false The default value. Payments are processed by the Payment rules engine.
attrTelesalesPageName	This policy property is used to specify the name of the Multiple Sales Center client panel to prompt the user for payment attributes or parameter required by the payment policy. If this property is not set, the default value will be the value of property attrPageName.