Extended data in payments or credits
WebSphere Commerce uses predefined keywords to pass protocol data details to a payment plug-in for processing with a payment back-end system. This protocol data is passed from an order to Payment Rules, to WebSphere Commerce Payments, and then to the payment plug-in for communication with a payment back-end system.
Some payment plug-ins require extra protocol data or keywords to communicate with a back-end system. This extra or non-standard data necessary is provided with an order as extended data. The keywords (both standard and non-standard) are passed inside of a hash map called ExtendedData. The hash map is used by both Payment Rules and WebSphere Commerce Payments.
You can think of extended data as being any data other than regular data. Regular data would be the currency, amount of the payment instruction, and payment method name. Extended data is everything else, such as the credit card number, expiration, billing address.
Extended data is collected through the following ways:
- JSP snippets tailored for a particular payment method can collect the additional data when the order is placed in the store. For example, a JSP snippet can collect credit card information such as the credit card number, expiration date, and expiration year. The electronic check payment method would use a different set of keywords that would include a check number and check routing number.
- A plug-in can supply the additional extended data required.
- The WebSphere Commerce Accelerator can be used to add, delete, or edit extended data for pending payment or credit transactions when necessary (for emergency or atypical situations).
There are two types of protocol or extended data:
- Extended data for a payment instruction
- Extended data for a pending credit or payment transaction
The WebSphere Commerce Accelerator can be used to edit both types of extended data. The extended data for a payment instruction lists both the common protocol keywords and unique keywords required for a payment method. This list corresponds to the list of keywords found in the JSP snippet supporting the payment method.
In contrast, the list of keywords shown in the WebSphere Commerce Accelerator pages when editing extended data for a pending payment or credit transaction is used on a transaction only basis and does not correspond to the list of keywords supported in the JSP snippet for the payment method. The payment plug-ins provided in WebSphere Commerce do not utilize extended data keywords for pending credit or payment transactions.
(C) Copyright IBM Corporation 1996, 2006. All Rights Reserved.