WebSphere Commerce Payments plug-in and Cashier profiles
A Cashier profile is an XML document that describes how an order is created in WebSphere Commerce Payments for a particular payment method. Each payment cassette in WebSphere Commerce has one or more Cashier profiles. More than one Cashier profile can be provided to address special situations. For example, the Cassette for VisaNet has a Cashier profile for regular credit card transactions, and a separate profile to handle purchasing card transactions. Cashier profiles contain information needed to process requests, such as the command to use for that payment method, a list of the parameters required for WebSphere Commerce Payments and the cassette, and any optional parameters. For example, the Cashier profile for the OfflineCard Cassette identifies special parameters needed to process Address Verification Service (AVS) data, and special parameters required by WebSphere Commerce Payments to execute the DEPOSIT command when performing offline payment transactions.
When the WebSphere Commerce Payments plug-in communicates with WebSphere Commerce Payments, it uses the Cashier profiles provided in WebSphere Commerce for use with the WebSphere Commerce Payments component, with some minor differences. Some parameter names are changed to follow the normalized keywords for a payment instruction.
Important! Do not change the parameters listed as required by the cassette or WebSphere Commerce Payments in the Cashier profiles that are provided. If you currently use WebSphere Commerce Payments and one of the payment cassettes provided, you can add new parameters if necessary but do not remove or change those that are required as stated in the profile. For example, do not change this line:
<Parameter name="$PANB" sensitive="true"><CharacterText>{account}</CharacterText></Parameter>
to this line:
<Parameter name="$PANB" sensitive="true"><CharacterText>{ACCOUNT}</CharacterText></Parameter>
If you are developing a payment cassette or using a third-party payment cassette and want to use the WebSphere Commerce Payments plug-in, include certain parameters required by the WebSphere Commerce Payments plug-in for the plug-in to work properly. These parameters are required for the invocation of the collectPayment and Deposit commands.
The following parameters are required for the CollectPayment element (<CollectPayment>) in a Cashier profile:
- storeID
- orderId
- CURRENCY
- AMOUNT
- AMOUNTEXP10
- purchaseorder_id
- card_number
The following parameters are required for the Deposit command in the Cashier profile (<Command name="DEPOSIT">):
- storeId
- orderId
- payment_number
- AMOUNT
Optional parameters are noted in the comments within each profile.
Important! The APPROVEFLAG and DEPOSITFLAG parameters are not used by the WebSphere Commerce Payments plug-in. The automatic approval and depositing of funds is handled through Payment Rules instead of these parameters. If either of these parameters contains a non-zero character text value in the Cashier profile, the WebSphere Commerce Payments plug-in will not work correctly. Therefore, do not set the value of these two parameters to anything other than zero (0).
If a value other than zero is set, the approve or deposit API cannot be controlled properly by Payment Rules or the WebSphere Commerce Payments. For example, if the WebSphere Commerce Payments requests that an approve transaction take place, and the DEPOSITFLAG is set to 1, the payment will be approved and deposited in WebSphere Commerce Payments without the Controller or the Payment Rules subcomponent knowing about it. If the Controller requests another deposit to take place, the deposit operation will fail in WebSphere Commerce Payments because a payment has already been deposited.
(C) Copyright IBM Corporation 1996, 2006. All Rights Reserved.