|
Direct Payment Integrator V6
Questions / Feedback?
TSYSGiftCard Configuration
The class accepts one or more of the following configuration settings.
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the class, access to these internal properties
is provided through the Config method.
TSYSGiftCard Configuration Settings | | | AuthorizationIndicator: The type of authorization request.This field defines the type of authorization request and must be included on all MasterCard authorization request transactions.
Valid values are:
| | Code | Description | P | Pre Authorization | F | Final Authorization | U | Undefined Authorization |
| | Retry: Set this to retry a failed transaction.If an authorization returns ambiguously or times out without receiving a response, you may send the same
transaction over again with this Retry flag set to True. This will prevent you from double-charging
your customers in the case of a communications error (only available for credit card transactions. Does not
apply to Debit, Gift Card, or EBT transactions).
| | SendExtendedAVS: Specifies whether to send extended AVS data.When set to 'True', AVS data will be sent in the extended AVS field for the transaction. ResponseCardholderVerification
will contain the extended AVS verification results. When set to 'False' (default value), the CustomerAddress and CustomerZip
values will be sent using the simple AVS data fields.
| | ResponseStoreNumber: Check this field against the original Merchant StoreNumber.The value of this field is used to correctly match responses with transactions by comparing its value to that of the
MerchantStoreNumber. This is particularly useful when making a multi-merchant or multi-store routing system.
If the system that originally made the transaction receives a response where the ResponseStoreNumber
is not identical to the MerchantStoreNumber the transaction should not be stored for batch settlement. This field is read-only.
| | ResponseTerminalNumber: Check this field against the original Merchant TerminalNumber.The value of this field is used to correctly match responses with transactions by comparing its value to that of
MerchantTerminalNumber. This is particularly useful when making a multi-terminal routing system within a
merchant location. If the terminal that originally made the transaction receives a response where the
ResponseTerminalNumber is not identical to the MerchantTerminalNumber, the transaction
should not be stored for batch settlement. This field is read-only.
| | ResponseCardholderVerification: Verification results for cardholder identification data (extended AVS).This response data is returned when SendExtendedAVS is set to 'True' and is only available for American Express and Discover cards.
This data is arranged in order of 5 bytes, one for each result of a cardholder identification data element:
| | Byte Number | Description | Byte 1 | Billing ZIP Code | Byte 2 | Billing Street Match Code | Byte 3 | Billing Name Match Code | Byte 4 | Telephone Number Match Code | Byte 5 | E-mail Address Match Code |
The possible values for each byte are:
| | Value | Description | Y | Data Matches | U | Data Unchecked | N | No Match | S | Service not allowed | R | Retry | ' ' (Space) | Data not sent |
For Discover transactions, byte 3 will be populated with the following values:
| | Value | Description | B | No response due to blank input | K | Unknown | P | Not processed | M | First Name and Last Name match | F | First Name Matches, Last Name does not match | L | First Name does not match, Last Name matches | N | Nothing matches | W | No data from Issuer/Authorization system | U | Retry, system unable to process |
| | Port: The port to which transactions are posted.This is port that this class connects to on the server. The default value for TSYS is
5003 for the live server, and 5004 for the test server. The default live server values for
Heartland is 22341 for Authorization and 22342 for Settlement. The Heartland test server values
are 12341 for Authorization and 12342 for Settlement.
| | Server: The server to which transactions are posted.This is name of the server to which all transactions are posted. Do not use an IP address,
use the actual name, as a server's IP address may change. The default (Live) TSYS server is
"ssl2.vitalps.net", but you may use "ssltest.tnsi.com" for testing. The default (Live) Heartland
server is "txns.secureexchange.net", but you may use "test.txns.secureexchange.net" for testing.
Note that there are several MerchantBankIds and MerchantNumbers that will always run in
test mode regardless of whether you are using the live server. See the included demos for examples.
| | AuthenticationCode: An alphanumeric code provided to the POS user for input when authenticating a POS device.This field is used to specify the AuthenticationCode, assigned by TSYS, to authenticate a POS device
(made via a call to ActivateTerminal).
| | ActivateTerminal: Authenticates a POS device with TSYS.This is an action config which when called will authenticate a POS device with TSYS. Authentication
is required when processing transactions using Voltage Encryption or Tokenization. An
AuthenticationCode is required to be specified, as is MerchantZip and/or
MerchantServicePhone, to perform authentication. After a POS device is successfully authenticated,
GenKey will be populated.
| | DeactivateTerminal: Deactivates a POS device with TSYS.This is an action config which when called will deactivate the POS device specified via GenKey with TSYS.
| | GenKey: A randomly generated string of alphanumeric characters identifying the terminal.This field is used to specify retrieve or specify a GenKey value for a terminal. This field will be populated
after a successful call to ActivateTerminal is made. The Genkey must be stored in the POS
device, must be sent with every request to the TSYS Acquiring Solutions host after authentication (by setting this
field), and will be checked against the terminal hierarchy. A GenKey value is required when processing transactions
using Voltage Encryption or Tokenization.
| | TsysETB: The Encryption Transmission Block TSYS uses to decrypt encrypted data.This field is used to specify the Base-64 encoded ETB (Encryption Transmission Block) used by TSYS to decrypt Voltage
encrypted data. The value is retrieved from the POS device containing the Voltage encryption software. When specified,
the transaction will be sent as a Voltage encrypted transaction. The encrypted card data will be specified as normal
via the CardMagneticStripe or CardNumber fields.
| | POSDataCode: Specifies the condition of the POS device used at the time of the transaction.This configuration setting takes a semi-colon separated list of name-value pairs. The available field names and their
applicable values can be found below. The fields can be set in any order and not all fields are required to be set
(unless you wish to change their default values).
Code Example:
TSYSRetail.Config("POSDataCode=CardholderAuthCap=1;CardInputMode=2;CardInputCap=2");
CardInputCap (Terminal data - card data input capability)
| | 0 (default) | Unspecified, data not available | 1 | Manual; no terminal | 2 | Magnetic stripe reader capability | 4 | Optical character reader (OCR) capability, [MC] | 5 | Integrated circuit card (ITSYS) capability | 6 | Key entry only capability | A | PAN auto-entry via contactless magnetic stripe | B | Magnetic stripe reader and key entry capability | C | Magnetic stripe reader, ITSYS, and key entry capability | D | Magnetic stripe reader and ITSYS capability | E | ITSYS and key entry capability | H | ITSYS Reader and Contactless Capability | M | PAN auto-entry via contactless chip | V | Other capability, [MC] | X | Magnetic stripe signature, [AX] |
CardholderAuthCap (Terminal data - cardholder authentication capability)
| | 0 | No electronic authentication capability | 1 | PIN entry capability | 2 | Electronic signature analysis capability | 5 | Electronic authentication capability is inoperative | 6 | Other | 9 (default) | Unspecified, data not available |
CardCaptureCap (Terminal data - card capture capability)
| | 0 | No capture capability | 1 | Card capture capability | 9 (default) | Unspecified, data not available |
TerminalOpEnv (Terminal operating environment)
| | 0 | No terminal used | 1 | On card acceptor premises; attended terminal | 2 | On card acceptor premises; unattended terminal | 3 | Off card acceptor premises; attended | 4 | Off card acceptor premises; unattended | 5 | On cardholder premises; unattended | 6 | Off cardholder premises; unattended | 9 (default) | Unspecified, data not available | S | Electronic delivery of product, [AX] | T | Physical delivery of product, [AX] |
CardholderPresent (Cardholder present data)
| | 0 | Cardholder present | 1 | Cardholder not present; unspecified reason | 2 | Cardholder not present; mail transaction | 3 | Cardholder not present; phone transaction | 4 | Cardholder not present; standing (recurring) transaction | 5 | Cardholder not present; electronic commerce | 8 | Not present, recurrent billing | 9 (default) | Unspecified, data not available |
CardPresent (Card present data)
| | 0 | Card not present | 1 | Card present | 9 (default) | Unspecified, data not available | W | Transponder, [AX] | X | Contactless Chip |
CardInputMode (Card data - input mode)
| | 0 (default) | Unspecified, data not available | 1 | Manual input; no terminal | 2 | Magnetic stripe reader input | 6 | Key entered input | A | PAN auto-entry via contactless magnetic stripe | B | Magnetic stripe reader input; track data captured and passed unaltered | C | Online Chip | F | Offline Chip | M | PAN auto-entry via contactless Chip Card | N | Track data read and sent unaltered, chip capable terminal, chip data could not be read | P | Empty candidate list fallback | S | Electronic commerce, no security, channel encrypted, or SET without cardholder certificate, [MC] | V | Manually entered with keyed CID, [AX, JCB Canada] | W | Swiped transaction with keyed CID, [AX, JCB Canada] | X | Magnetic stripe signature, [AX, JCB Canada] | Y | Magnetic stripe signature with keyed CID, [AX, JCB Canada] |
CardholderAuthMethod (Cardholder authentication method)
| | 0 | Not authenticated | 1 | PIN | 2 | Electronic signature analysis | 5 | Manual signature verification | 6 | Other manual verification (such as a driver's license number) | 9 (default) | Unspecified, data not available | S | Other systematic verification | T | Electronic ticket environment, [AX] |
CardholderAuthEntity (Cardholder authentication entity)
| | 0 | Not authenticated | 1 | ITSYS, Offline PIN | 2 | Card acceptance device (CAD) | 3 | Authorizing agent, Online PIN | 4 | Merchant/card acceptor - signature | 5 | Other | 9 (default) | Unspecified, data not available |
CardOutputCap (Card data output capability)
| | 0 (default) | Unspecified, data not available | 1 | None | 2 | Magnetic stripe write | 3 | ITSYS | S | Other |
TerminalOutputCap (Terminal data output capability)
| | 0 (default) | Unspecified, data not available | 1 | None | 2 | Printing capability only | 3 | Display capability only | 4 | Printing and display capability |
PINCaptureCap (PIN capture capability)
| | 0 | No PIN capture capability | 1 (default) | Unspecified, data not available | 2 | Reserved | 3 | Reserved | 4 | PIN capture capability four characters maximum | 5 | PIN capture capability five characters maximum | 6 | PIN capture capability six characters maximum | 7 | PIN capture capability seven characters maximum | 8 | PIN capture capability eight characters maximum | 9 | PIN capture capability nine characters maximum | A | PIN capture capability 10 characters maximum | B | PIN capture capability 11 characters maximum | C | PIN capture capability 12 characters maximum |
|
Base Configuration Settings | | | SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.
|
Base Configuration Settings | | | CodePage: The system code page used for Unicode to Multibyte translations.
The default code page is the Active Code Page (0).
The following is a list of valid code page identifiers:
| | Identifier | Name | 037 | IBM EBCDIC - U.S./Canada | 437 | OEM - United States | 500 | IBM EBCDIC - International | 708 | Arabic - ASMO 708 | 709 | Arabic - ASMO 449+, BCON V4 | 710 | Arabic - Transparent Arabic | 720 | Arabic - Transparent ASMO | 737 | OEM - Greek (formerly 437G) | 775 | OEM - Baltic | 850 | OEM - Multilingual Latin I | 852 | OEM - Latin II | 855 | OEM - Cyrillic (primarily Russian) | 857 | OEM - Turkish | 858 | OEM - Multlingual Latin I + Euro symbol | 860 | OEM - Portuguese | 861 | OEM - Icelandic | 862 | OEM - Hebrew | 863 | OEM - Canadian-French | 864 | OEM - Arabic | 865 | OEM - Nordic | 866 | OEM - Russian | 869 | OEM - Modern Greek | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | 875 | IBM EBCDIC - Modern Greek | 932 | ANSI/OEM - Japanese, Shift-JIS | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | 949 | ANSI/OEM - Korean (Unified Hangeul Code) | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | 1026 | IBM EBCDIC - Turkish (Latin-5) | 1047 | IBM EBCDIC - Latin 1/Open System | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | 1148 | IBM EBCDIC - International (500 + Euro symbol) | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | 1201 | Unicode UCS-2 Big-Endian | 1250 | ANSI - Central European | 1251 | ANSI - Cyrillic | 1252 | ANSI - Latin I | 1253 | ANSI - Greek | 1254 | ANSI - Turkish | 1255 | ANSI - Hebrew | 1256 | ANSI - Arabic | 1257 | ANSI - Baltic | 1258 | ANSI/OEM - Vietnamese | 1361 | Korean (Johab) | 10000 | MAC - Roman | 10001 | MAC - Japanese | 10002 | MAC - Traditional Chinese (Big5) | 10003 | MAC - Korean | 10004 | MAC - Arabic | 10005 | MAC - Hebrew | 10006 | MAC - Greek I | 10007 | MAC - Cyrillic | 10008 | MAC - Simplified Chinese (GB 2312) | 10010 | MAC - Romania | 10017 | MAC - Ukraine | 10021 | MAC - Thai | 10029 | MAC - Latin II | 10079 | MAC - Icelandic | 10081 | MAC - Turkish | 10082 | MAC - Croatia | 12000 | Unicode UCS-4 Little-Endian | 12001 | Unicode UCS-4 Big-Endian | 20000 | CNS - Taiwan | 20001 | TCA - Taiwan | 20002 | Eten - Taiwan | 20003 | IBM5550 - Taiwan | 20004 | TeleText - Taiwan | 20005 | Wang - Taiwan | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | 20106 | IA5 German (7-bit) | 20107 | IA5 Swedish (7-bit) | 20108 | IA5 Norwegian (7-bit) | 20127 | US-ASCII (7-bit) | 20261 | T.61 | 20269 | ISO 6937 Non-Spacing Accent | 20273 | IBM EBCDIC - Germany | 20277 | IBM EBCDIC - Denmark/Norway | 20278 | IBM EBCDIC - Finland/Sweden | 20280 | IBM EBCDIC - Italy | 20284 | IBM EBCDIC - Latin America/Spain | 20285 | IBM EBCDIC - United Kingdom | 20290 | IBM EBCDIC - Japanese Katakana Extended | 20297 | IBM EBCDIC - France | 20420 | IBM EBCDIC - Arabic | 20423 | IBM EBCDIC - Greek | 20424 | IBM EBCDIC - Hebrew | 20833 | IBM EBCDIC - Korean Extended | 20838 | IBM EBCDIC - Thai | 20866 | Russian - KOI8-R | 20871 | IBM EBCDIC - Icelandic | 20880 | IBM EBCDIC - Cyrillic (Russian) | 20905 | IBM EBCDIC - Turkish | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | 20932 | JIS X 0208-1990 & 0121-1990 | 20936 | Simplified Chinese (GB2312) | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | 21027 | Extended Alpha Lowercase | 21866 | Ukrainian (KOI8-U) | 28591 | ISO 8859-1 Latin I | 28592 | ISO 8859-2 Central Europe | 28593 | ISO 8859-3 Latin 3 | 28594 | ISO 8859-4 Baltic | 28595 | ISO 8859-5 Cyrillic | 28596 | ISO 8859-6 Arabic | 28597 | ISO 8859-7 Greek | 28598 | ISO 8859-8 Hebrew | 28599 | ISO 8859-9 Latin 5 | 28605 | ISO 8859-15 Latin 9 | 29001 | Europa 3 | 38598 | ISO 8859-8 Hebrew | 50220 | ISO 2022 Japanese with no halfwidth Katakana | 50221 | ISO 2022 Japanese with halfwidth Katakana | 50222 | ISO 2022 Japanese JIS X 0201-1989 | 50225 | ISO 2022 Korean | 50227 | ISO 2022 Simplified Chinese | 50229 | ISO 2022 Traditional Chinese | 50930 | Japanese (Katakana) Extended | 50931 | US/Canada and Japanese | 50933 | Korean Extended and Korean | 50935 | Simplified Chinese Extended and Simplified Chinese | 50936 | Simplified Chinese | 50937 | US/Canada and Traditional Chinese | 50939 | Japanese (Latin) Extended and Japanese | 51932 | EUC - Japanese | 51936 | EUC - Simplified Chinese | 51949 | EUC - Korean | 51950 | EUC - Traditional Chinese | 52936 | HZ-GB2312 Simplified Chinese | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | 57002 | ISCII Devanagari | 57003 | ISCII Bengali | 57004 | ISCII Tamil | 57005 | ISCII Telugu | 57006 | ISCII Assamese | 57007 | ISCII Oriya | 57008 | ISCII Kannada | 57009 | ISCII Malayalam | 57010 | ISCII Gujarati | 57011 | ISCII Punjabi | 65000 | Unicode UTF-7 | 65001 | Unicode UTF-8 |
The following is a list of valid code page identifiers for Mac OS only:
| | Identifier | Name | 1 | ASCII | 2 | NEXTSTEP | 3 | JapaneseEUC | 4 | UTF8 | 5 | ISOLatin1 | 6 | Symbol | 7 | NonLossyASCII | 8 | ShiftJIS | 9 | ISOLatin2 | 10 | Unicode | 11 | WindowsCP1251 | 12 | WindowsCP1252 | 13 | WindowsCP1253 | 14 | WindowsCP1254 | 15 | WindowsCP1250 | 21 | ISO2022JP | 30 | MacOSRoman | 10 | UTF16String | 0x90000100 | UTF16BigEndian | 0x94000100 | UTF16LittleEndian | 0x8c000100 | UTF32String | 0x98000100 | UTF32BigEndian | 0x9c000100 | UTF32LittleEndian | 65536 | Proprietary |
|
|