Data Structures

Notes

For all PaymentData, a “Source” type must be defined.  Depending on the source, please follow the information below.

Reader Payment Source

Data from Track 2 is required for the TrackData parameter. However, you may send in the raw swipe, as long as it has not been altered since it was read from the payment card. This method will separate Track 2 data by itself.
The TrackData should be unaltered raw swipe data from an unencrypted reader or from an IDTECH, IDTECH Enhanced, or Magtek encrypted reader.
The ReaderEntryMode is defaulted to MAGNETICSTRIPE if it is left blank.

Keyed Payment Source

The expiration date should be specified in the form "MMYY", the same ordering as a card holder would physically see on their card. For example, a card expiring in November 2008 would be specified as 1108.
The card security code is composed of the three extra digits printed on the back of most credit cards, although most American Express cards have a four digit number displayed on the front of the card.
It is in your best interest to always send in the address verification information and Card Security Code whenever possible.  You can use this information to contest chargebacks and disputes.

Vault Payment Source

It is in your best interest to always send in the address verification information and Card Security Code whenever possible.  You can use this information to contest chargebacks and disputes.

Encrypted Keyed Payment Source

The EncryptedKeyedData field within the PaymentData object allows the merchant to use an IDTech encrypted-keypad to supply encrypted keyed data. 

The IDTech keypad can produce outputs in two formats:

• Standard/Original
• Enhanced

Within the web method, the EncryptedKeyedData is identified, parsed and decrypted. 

• If the EncryptedKeyedData element is supplied, the transaction is identified as coming from an Encrypted Keyed Reader.
• The EncryptedKeyedData element contains the encrypted keyed data from the encrypted keypad.
• The Source element under the PaymentData element still contains the value Keyed, even though a reader was used for data capture.
• The existing text states that address verification information and CVV should be sent whenever possible. This will not always be the case with a Keyed transaction performed via the reader since the Address verification information and CVV can be potentially included within the encrypted keyed data.
• If fields are parsed from the EncryptedKeyedData, that is the CVV, Street Address, or Zipcode, they will always be used in preference over the same field if it has been supplied in the PaymentData request. However PAN and Expiry Date must always come from the EncryptedKeyedData field.

Notes

This ImageData field uses a simple format to denote ligatures from a drawn signature. A coordinate is defined by an integer, followed by a comma, followed by another integer, and then finally terminated with a caret. The first coordinate specifies the X or horizontal position. The second coordinate specifies the Y or vertical position. 0,0 is the top-left most coordinate. 65535,65535 is the bottom-right most coordinate.

100,100^

To specify the end of a segment, use the special coordinate 0,65535^ (Pen-up) in the string of text. At the very end of the list of coordinates, append a tilde at the end. Your data should resemble the following output.
10,10^110,110^0,65535^10,110^110,10^0,65535^~

The aforementioned string results in an X being drawn. It contains first the top-left corner to the bottom right corner, then a pen-up coordinate, then the bottom-left to the top-right coordinate, and then a pen-up coordinate.
A pen-up coordinate is not required at the very end, but for your own purposes, it may be useful to specify one when replaying the string for screen drawing or for an image.

The size limit for this method may be increased in the future. For the time being, if you find the size limit on this method is too restrictive, try reducing your sampling frequency when recording a signature, particularly if you are recording a signature from a desktop application. Most POS devices do not have nearly the same resolution as a windowed application on a PC, so a finely detailed signature is not required to create a comparable image.

For best results, the signature coordinates should fall within a 240 by 240 range of dimensions.
Negative coordinates and coordinates outside of 65535 for any dimension are rejected by the web service.

The BatchResponse46 encapsulates the results of a retail batch operation in Merchantware.

Used By

SettleBatch

The SignatureResponse46 contains information about a signature appended to an existing transaction record. 

Used By

AttachSignature

Used By

AttachSignature, AdjustTip, Authorize, Capture, ForceCapture, Refund, Sale, Void

Used By

UnboardCard, UpdateBoardedCard

Used By

FindBoardedCard