Administer > Manage WebSphere Commerce features > Payments subsystem > Configure payment plug-ins
Configure the WCPayments plug-in
Use the WCPayments plug-in as a bridge from the WebSphere Commerce Payments Multipayment Framework using cassettes. If you are interested in using an offline payment mechanism, use the SimpleOffline plug-in instead.
Procedure
- Configure at least one cassette.
- Configure the payment system mapping. The following example shows the WCPayments plug-in is configured with BankServ payment system (the Cassette for BankServACH).
<PaymentSystemName name="BankServ" > <Mapping paymentConfigurationId="default" PluginName="WCPaymentsPlugin" > <Property name="ProfileName" value="WCPPlugin_BankServACH"/> <Property name="SupportsOnlineTransaction" value="yes"/> </Mapping> </PaymentSystemName>
- ProfileName
- The short form of the name of the Cashier profile.
- BankServACH profile - WCPPlugin_BankServACH
- CustomOffline COD.profile - WCPPlugin_CustomOffline_COD
- CustomOffline BillMe.profile - WCPPlugin_CustomOffline_BillMe
- OfflineCard cassette profile - WCPPlugin_OfflineCard
- Paymentech profile - WCPPlugin_Paymentech
- VisaNet profile for regular credit cards - WCPPlugin_VisaNet
- SupportsOnlineTransaction
- Yes
- Indicates that payment actions will be processed online.
- No
- Payment actions will be set as PENDING after the WebSphere Commerce Payments and theWCPayments plug-in process the offline transaction. After a manual action is taken to process the payment (such as approving the payment using the WebSphere Commerce Payments administration GUI), the WCPayments plug-in can issue a query to synchronize the transactions. When the Payment rules engine queries a payment or a credit, the payment or credit will be synchronized with the payment back-end system. If you are using the OfflineCard or CustomOffline payment cassettes, this value should be 'no'.
- In a text editor or XML editor, open the copy of the PaymentSystemPluginMapping XML file.
- Specify the payment system name, payment configuration ID, plug-in name, and any specific plug-in properties that should be used for that payment system name mapping.
Since a plug-in can be associated with more than one payment system name, you can specify properties that are unique to a particular payment system name. For example, PaymentSystemName ABC can use property XXX, and PaymentSystemName DEF can use property YYY even though the same plug-in is used for both.
When the payment system name is used, the set of properties defined in the PaymentSystemPluginMapping.xml file is applied. These properties are different from the plug-in properties specified in the deployment descriptor. The properties specified in the deployment descriptor apply to the plug-in itself and remain constant in memory as the plug-in is used, regardless of the payment system name being used. The deployment descriptor is described in the Payment plug-in specification.
- Save the file.
- Configure payment methods.
- In a text editor or XML editor, open the PaymentMethodConfigurations XML file which is in the following directory:
- WC_EAR/xml/config/payments/edp/groups/default
- workspace_dir/wc/xml/config/payments/edp/groups/default
- Specify a configuration for the payment method. Supply values for the following parameters:
- payment method
- paymentRule
- paymentSystemName
- systemEditable
- humanEditable
- refundAllowed
- minimumAmount
- maximumAmount
- priority
- dependentCreditRequired
Refer to the description of the file for more information about these parameters. Multiple payment methods can be configured in this file.
- Save the file.
- Configure refund methods.
- In a text editor or XML editor, open the RefundMethodConfigurations XML file which is in the following directory:
- WC_EAR/xml/config/payments/edp/groups/default
- workspace_dir/wc/xml/config/payments/edp/groups/default
- Specify a configuration for the refund method. Supply values for the following parameters:
- refund method
- paymentSystemName
Refer to the description of the file for more information about these parameters. Multiple refund methods can be configured in this file.
- Save the file.
- Modify the WCPayments plug-in deployment descriptor (PluginDeployment.xml) file to set the connection parameters, including the host name (WebSphere Commerce Payments Web server) and port. For instructions, see the topic
- Package your assets as a partial application.
- Deploy the changed assets.
- Ensure that WebSphere Commerce Payments is started.
Related concepts
WCPayments plug-in and Cashier profiles
Related reference
WCPayments plug-in and Cashier profiles
WCPPlugin_CustomOffline_COD.profile
WCPPlugin_CustomOffline_BillMe.profile
WCPayments plug-in deployment descriptor
WCPayments plug-in financial transactions