WCPPlugin_BankServACH.profile

Reference > Payments subsystem > WCPayments plug-in > WCPayments plug-in and Cashier profiles

WCPPlugin_BankServACH.profile

The following code is the cashier profile provided in WebSphere Commerce Payments for the Cassette for BankServACH.

The WCPPlugin_BankServACH.profile file is located in the following directory:

WC_EAR/xml/config/payments/ppc/plugins/WCPayments/

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Profile SYSTEM "profile.dtd"> 
<!-- ==================================================================
This is the Standard WebSphere
Commerce cashier profile for the Cassette for BankServACH. 
(This Cassette is for US Only.)
================================================================== --> 
<Profile useWallet="false" enableTrace="true" > 
<CollectPayment> 
<!-- ==================================================================
Parameters required by WebSphere
Commerce Payments for order creation
================================================================== --> 
<Parameter name="PAYMENTTYPE"><CharacterText>BankServACH</CharacterText></Parameter> 
<Parameter name="MERCHANTNUMBER"><CharacterText>{storeId}</CharacterText></Parameter>
<Parameter name="ORDERNUMBER"><CharacterText>{orderId}</CharacterText></Parameter>
<Parameter name="CURRENCY"><CharacterText>{CURRENCY}</CharacterText></Parameter>
<Parameter name="AMOUNT"><CharacterText>{AMOUNT}</CharacterText></Parameter>
<Parameter name="AMOUNTEXP10"><CharacterText>{AMOUNTEXP10}</CharacterText></Parameter> 
<!-- Indicates how automatic approval of the order should be attempted
Supported values are: 
0 - no automatic approval
1 - synchronous automatic approval - WebSphere
Commerce Payments attempts approval as
part of order creation operation
2 - asynchronous automatic approval - WebSphere
Commerce Payments schedules an approval
operations after order is created

WebSphere
Commerce works best with APPROVEFLAG set to 2. When the APPROVEFLAG is set to 1, the
DoPayment command is blocked until WebSphere
Commerce Payments completes the approval of the order. 
Until this approval is complete, any commands wanting to read/update the same inventory 
records modified by the DoPayment command will be blocked. This will affect the throughput
of the other commands.
-->
<Parameter name="APPROVEFLAG"><CharacterText>0</CharacterText></Parameter> 
<!-- The amount which should be used when approving an order. Typically
this will be the same as the order amount. This field is required
if the APPROVEFLAG is set to 1 or 2. -->
<Parameter name="PAYMENTAMOUNT"><CharacterText></CharacterText></Parameter> 
<!-- The payment number which should be used when approving an order.
Typically this will be 1. This field is required if the APPROVEFLAG
is set to 1 or 2. -->
<Parameter name="PAYMENTNUMBER"><CharacterText></CharacterText></Parameter> 
<!-- Indicates whether the deposit should be attempted automatically. 
This flag is only valid if APPROVEFLAG is set to 1 or 2.
Supported values are: 0 - Funds should not be automatically deposited. 
1 - Funds should be automatically deposited. 
The default value is 0.
-->
<Parameter name="DEPOSITFLAG"><CharacterText></CharacterText></Parameter> 
<!-- ==================================================================
Optional parameters for WebSphere
Commerce Payments
================================================================== --> 
<!-- The following two parameters are optional. Either one could be used to pass the 
Buyer Purchase Order number to WebSphere
Commerce Payments. The first Parameter takes only 
ASCII Text. If Buyer Purchase Order numbers on the system may contain non-ASCII 
Strings, use parameter ORDERDATA2 instead. 
-->
<Parameter name="TRANSACTIONID" maxBytes="128" encoding="ASCII"><CharacterText>{purchaseorder_id}</CharacterText></Parameter>
<Parameter name="ORDERDATA2"><CharacterText></CharacterText></Parameter> 
<!-- ==================================================================
Parameters required by the cassette
================================================================== -->
<!-- The checking account number -->
<Parameter name="$CHECKINGACCOUNTNUMBER"><CharacterText>{account}</CharacterText></Parameter> 
<!-- The check routing number -->
<Parameter name="$CHECKROUTINGNUMBER"><CharacterText>{check_routing_number}</CharacterText></Parameter> 
<Parameter name="$BUYERNAME" maxBytes="80" encoding="ASCII"><CharacterText>{billto_firstname} {billto_lastname}</CharacterText></Parameter>
<Parameter name="$STREETADDRESS" maxBytes="50" encoding="ASCII"><CharacterText>{billto_address1}</CharacterText></Parameter>
<Parameter name="$CITY" maxBytes="50" encoding="ASCII"><CharacterText>{billto_city}</CharacterText></Parameter> 
<!-- Only the 2-character US State Codes in Uppercase (for example, AL for Alabama, AK for Alaska, and so on) 
are accepted by the cassette. The BankServACH Cashier Extension class is used to locate 
the 2-character State Code from the WebSphere
Commerce STATEPROV Table using the value specified
in the {billto_state} environment variable as State name. The Cashier Extension returns null 
if no State Code can be found for the State name specified. For compatibility, the Extension 
class returns the {billto_state} environment variable value as the State code if the value is 
of length two.
-->
<Parameter name="$STATEPROVINCE" maxBytes="2" encoding="ASCII"><CharacterText>{billto_stateprovince}</CharacterText></Parameter>
<Parameter name="$POSTALCODE" maxBytes="9" encoding="ASCII"><CharacterText>{billto_zipcode}</CharacterText></Parameter>
<Parameter name="$COUNTRYCODE" maxBytes="2" encoding="ASCII"><CharacterText>US</CharacterText></Parameter>
<Parameter name="$PHONENUMBER" maxBytes="10" encoding="ASCII"><CharacterText>{billto_phone_number}</CharacterText></Parameter> 
<!-- ==================================================================
Optional parameters for the cassette
================================================================== -->
<Parameter name="$STREETADDRESS2" maxBytes="50" encoding="ASCII"><CharacterText></CharacterText></Parameter>
<Parameter name="$EMAILADDRESS" maxBytes="49" encoding="ASCII"><CharacterText></CharacterText></Parameter> 
</CollectPayment> 
<Command name="DEPOSIT">
<!-- ==================================================================
Parameters required by WebSphere
Commerce Payments for the DEPOSIT Command
================================================================== -->
<Parameter name="MERCHANTNUMBER"><CharacterText>{storeId}</CharacterText></Parameter>
<Parameter name="ORDERNUMBER"><CharacterText>{orderId}</CharacterText></Parameter>
<Parameter name="PAYMENTNUMBER"><CharacterText>{payment_number}</CharacterText></Parameter>
<Parameter name="AMOUNT"><CharacterText>{AMOUNT}</CharacterText></Parameter> 
</Command>
</Profile>

The PAYMENTTYPE parameter specifies the name of this profile's cassette.

WebSphere Commerce does not use the <BuyPageInformation> element of the Cashier profile. Comparable function is provided with the attrPageName property of the payment policy.

This Cashier profile uses the BankServACHCashierExtension CashierExtension class to obtain the 2-character state code for the required $STATEPROVINCE parameter. This class finds up the state code from the STATEPROV table using the value specified in the {billto_state} environment variable as the state name. The class returns null if a state code cannot be found for the specified state name. For compatibility, the CashierExtension returns the {billto_state} environment variable value as the state code if the value is the length of two characters.

The {billto_state} environment variable and the other {billto_*} environment variables are some of the name-value pairs passed to the Cashier as parameters for the Cashier collectPayment call. The values for these variables are from the corresponding columns in the ADDRESS table.

Alternatively, you could use a DatabaseValue for the $STATEPROVINCE parameter if you know that the STATE column in the ADDRESS table will only have valid state names as values.

WCPPlugin_BankServACH.profile

Related concepts

Related tasks

Related reference