Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

TSYSDetailRecord Configuration

The control 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 control, access to these internal properties is provided through the Config method.

DetailRecord Configuration Settings

AccountDataSource:   Identifies the source of the customer card data entered.

This field is sent in the request based on the CardEntryDataSource value specified by default. However that value can be overridden by setting this config.

Valid values are:

Code Description
A Bar code/Payment code read
D Full magnetic stripe read and transmit, Track two
G Chip Card Read Data (CCPS)
H Full magnetic stripe read and transmit, Track one
P Manually keyed, Chip Card read capable terminal
Q Proximity payment device using track data rules (transmit only Track two to Sierra)
R Proximity payment device using EMV-Chip data rules
S Full magnetic stripe read (Track two only), Chip Card capable terminal
T Manually keyed, Track two capable
X Manually keyed, Track one capable
@ Manually keyed, terminal has no card reading capability
W Chip Card transaction processed as magnetic stripe due to the terminal application not having any EMV applications in common with the chip card.
Z Chip Card transaction processed as magnetic stripe from a chip capable terminal, due to card or terminal failure.

VisaMVV:   Merchant Verification Value used for Visa healthcare transactions.

The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program. The maximum length of this property is 10 characters, and it may only contain 0-9 and A-F.

EMVData:   The EMV Data returned from a Pin Pad after reading an EMV card.

This configuration setting takes the entire TLV (tag-length-value) response received from a Pin Pad after reading an EMV card. When setting this field, any EMV tags that are not specified within the TSYS specifications, to include in the request, will be removed from the input. The component will send this data in an authorization request. Note that when performing an EMV transaction, POSDataCode is required.

Processor:   Specifies the Processor you are connecting to.

This field allows you to specify the processor that you are connecting to (thus allowing the control to correctly generate the request and parse the response). The available values are:

0TSYS (default)
1Heartland

Note that when set, this property will set the Server and Port to the default values for the specified processor. Additionally, this config must be set prior to setting Card to ensure the card data is formatted correctly.

HeartlandEncryptionMode:   Specifies the encryption mode to use in Heartland transactions.

This field allows you to specify the Heartland E3 encryption mode used when processing Heartland transactions. The available values are (descriptions describe the data that will be encrypted):

0No Encryption (default)
1Merchant ID and Card Data (reserved for future use)
2Merchant ID, Card Data, and Card Security Code (reserved for future use)
3Card Data Only

Note you will also need to set Processor to 1 (Heartland) and HeartlandKeyBlock if you wish to process Heartland E3 transactions.

HeartlandDeviceId:   Specifies a device ID to uniquely identify each terminal (card data entry device).

The specified value must be 4 characters or less. Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.

RequesterName:   Name of the requester.

This configuration setting can be used to set the name of the requester, if the card holder is not the person that ordered or purchased the product or service. This configuration setting applies to the Amex CAPN Corporate Purchasing Solution Extension.

TotalTaxAmount:   Total Tax Amount assessed at the point-of-sale.

This configuration setting can be used to set the total of all taxes applicable to a transaction and it should not be used to report individual line item details for taxes. This configuration setting applies to the Amex CAPN Corporate Purchasing Solution Extension.

DetailExtension:   Detail Extension Optional Data Group.

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.

CodeExample:

  DetailRecord.Config("DetailExtension=PTI=C02;TTT=02;TMI=01");

OAI (Optional Amount Identifier)

0 Not Used
1 Local Sales Tax Amount
2 Tax Exempt

OA (Optional Amount)

This field can be used to set the Optional Amount.

PON (Purchase Order Number)

This field can be used to set a 16, 17 or 25-character Purchase Order Number supplied by Visa or MasterCard Purchasing Card cardholder.

PTI (Payment Transaction Indicator)

C01 Person to Person
C02 MasterCard Rebate
C03 rePower Load Value
C04 Gaming Re-Pay
C05 Miscellaneous Payment Transaction
C06 Payment of Credit Card Balance with Cash or Check

IIA (MC IIAS Indicator)

0 Merchant terminal did not verify the purchased items against an IIAS
1 Merchant terminal did verify the purchased items against an IIAS
2 Merchant claims exemption from IIAS based on the 90 percent rule

SID (Merchant Seller ID)

A seller/vendor code that uniquely identifies an aggregator's specific seller/vendor

ATS (Association Timestamp)

This field can be used to set the timestamp data provided by the association.

TTT (Transit Transaction Type Indicator)

01 Prefunded
02 Real-time Authorized
03 Post-Authorized Aggregated
04 Authorized Aggregated Split Clearing
05 Other
07 Debt Recovery

TMI (Transportation Mode Indicator)

00 Unknown
01 Urban Bus
02 Interurban Bus
03 Light Train Mass Transit (Underground Metro, LTR)
04 Train
05 Communter Train
06 Water Borne Vehicle
07 Toll
08 Parking
09 Taxi
10 High Speed Train
11 Rural Bus
12 Express Commuter Train
13 Para Transit
14 Self Drive Vehicle
15 Coach
16 Locomotive
17 Powered Motor Vehicle
18 Trailer
19 Regional Train
20 Inter City
21 Funicular Trailer
22 Cable Car

TFA (Transaction Fee Amount with Indicator)

C The surcharge indicates a credit to the consumer account.
D The surcharge indicates a debit from the consumer account.

Transaction fee amount is used in credit transactions to carry the acquirer-assessed surcharge for informational purposes only. This field can be zero length or nine alphanumeric characters in length. The format of the nine characters is "annnnnnnn" where "a" is either "D" for debit or "C" for credit and where "nnnnnnnn" is the numeric fee amount with the decimal implied.

Example: "D00000150" is a $1.50 transaction fee amount debited to the cardholder's account.

MDO (Domain Server)

0 No domain.
1 Issuer domain.
2 Acquirer domain.

MDE (Mobile Device Type) This field is required for all MasterCard PayPass (contactless) transactions.

Value Description
00 Card (default)
01 Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a Mobile Phone or Smartphone.
02 Key Fob
03 Watch
04 Mobile Tag
05 Wristband
06 Mobile Phone Case or Sleeve
07 Mobile Phone or Smartphone with a fixed (non-removable) secure element controlled by the MNO. For example, code division multiple access CDMA.
08 Removable secure element not controlled by the MNO. For example, SD Card personalized for use with a Mobile Phone or Smartphone.
09 Mobile Phone or Smartphone with a fixed (non-removable) secure element not controlled by the MNO.
10 MNO controlled removable secure element (SIM or UICC) personalized for use with a Tablet or E-Book.
11 Tablet or E-Book with a fixed (non-removable) secure element controlled by the MNO.
12 Removable secure element not controlled by the MNO. For example, SD Card personalized for use with a Tablet or E-Book.
13 Tablet or E-Book with a fixed (non-removable) secure element not controlled by the MNO.

DTC (Invoice Level Discount Treatment Code)

Value Description
0 No invoice-level discount was provided.
1 Tax was calculated on the post-discount invoice total.
2 Tax was calculated on the pre-discount invoice total.
[SP] (' ' - Space)Field not used.

TTC (Tax Treatment Code)

Value Description
0 NLL - Net prices with tax calculated at the line item level.
1 NIL - Net prices with tax calculated at the invoice level
2 GLL - Gross prices given with tax information provided at the line item level.
3 GIL - Gross prices given with tax information provided at the invoice level.
4 NON - No tax applies
[SP] (' ' - Space)Field not used.

SQI (Spend Qualified Indicator)

Value Description
B Base spend assessment threshold has been met.
N Spend qualification threshold has not been met.
Q Spend qualification threshold has been met.
[SP] (' ' - Space)Spend qualification does not apply.

TAL (Token Assurance Level)

Defined by the token service provider, this Visa or MasterCard value indicates the assigned confidence level of the token-to-PAN/cardholder binding.

TRI (Token Requestor ID)

This 11-character alphanumeric field contains the value that uniquely identifies the pairing of token requestor with the token domain. This value is sent in capture to identify the requestor to the card brand.

ARS (Account Range Status)

Value Description
R Regulated.
N Non-Regulated.

WID (MasterCard Wallet Identifier)

This is a MasterCard value that is generated by the MasterPass online platform. This value is passed to the merchant at the time of consumer checkout for e-commerce transactions, and is included in the authorization request.

ISO (ISO ID)

This 11-digit field, assigned by MasterCard, is assigned during registration via MasterCard Connect for a Service Provider designated as an "Independent Sales Organization". This value must be provided on all MasterCard transactions where the merchant has a relationship with an ISO.

PFI (Payment Facilitator ID)

This 11-digit field, assigned by MasterCard, is assigned during registration via MasterCard Connect for the Service Provider designated as a "Payment Facilitator." This value must be present on all MasterCard transactions that originate from a Payment Facilitator.

SMI (Sub-Merchant ID)

This 15-digit field, assigned by the Payment Facilitator or the Acquirer, must be provided on all MasterCard transactions that originate from a Payment Facilitator.

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.

Token:   The token used in place of Card data.

This field will contain the token received from TSYS and used in place of Card data. This is used as an added security measure to protect a customer's Card and may also help decrease PCI Compliance verification as storing credit card data is no longer needed.

MobileDeviceType:   Identifies the type of mobile device used by the cardholder to initiate the transaction.

This field is required for all MasterCard PayPass (contactless) transactions. Valid values are:

Value Description
00 Card (default)
01 Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a Mobile Phone or Smartphone.
02 Key Fob
03 Watch
04 Mobile Tag
05 Wristband
06 Mobile Phone Case or Sleeve
07 Mobile Phone or Smartphone with a fixed (non-removable) secure element controlled by the MNO. For example, code division multiple access CDMA.
08 Removable secure element not controlled by the MNO. For example, SD Card personalized for use with a Mobile Phone or Smartphone.
09 Mobile Phone or Smartphone with a fixed (non-removable) secure element not controlled by the MNO.
10 MNO controlled removable secure element (SIM or UICC) personalized for use with a Tablet or E-Book.
11 Tablet or E-Book with a fixed (non-removable) secure element controlled by the MNO.
12 Removable secure element not controlled by the MNO. For example, SD Card personalized for use with a Tablet or E-Book.
13 Tablet or E-Book with a fixed (non-removable) secure element not controlled by the MNO.

SpendQualifiedIndicator:   Indicates whether or not the spend qualification threshold has been met.

This field is for High Value card transactions. Valid values are:

Value Description
B Base spend assessment threshold has been met.
N Spend qualification threshold has not been met.
Q Spend qualification threshold has been met.
[SP] (' ' - Space)Spend qualification does not apply.

EMVTranType:   The Transaction Type used by the card to calculate the cryptogram.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVTranDate:   The local date at the terminal on which the transaction was authorized.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config. The value must be in YYMMDD format.

EMVVerificationResult:   The indicators representing the results of offline and online processing, recorded by the terminal.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVCurrencyCode:   The currency code of the transaction.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVAppTranCounter:   The count of the transactions performed within the application.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVAppInterchangeProfile:   A series of indicators that reflect the specific functions supported by the chip card account.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVAppCryptogram:   The clearing cryptogram used to validate transaction processing in the event of a dispute.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVUnpredictableNum:   The number used in the generation of the cryptogram.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVIssuerAppData:   Application data for transmission to the issuer in an online transaction.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVCryptogramInfoData:   The type of cryptogram and the actions to be performed by the terminal.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVTerminalCapabilities:   Indicates the card input data, the Cardholder Verification Method (CVM), and the security capabilities that are supported by the terminal.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVCardSeqNum:   The number assigned to a specific card when two or more cards are associated with a single account number.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVIssuerAuthData:   Data sent by the Issuer to the Chip Card for the Chip Card to validate the authenticity of the Issuer.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVCVMResults:   The results of the last Cardholder Verification Method (CVM) performed.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVIssuerScriptResults:   The update command that the issuer sends in the authorization response to the card during online processing.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVFormFactorID:   This indicators related to the attributes of the cardholder's device and the technology used for the communication between the cardholder's device and the acquiring device.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

EMVCryptogramAmount:   Contains the transaction amount used by the chip when calculating the last cryptogram.

This value is returned by the EMV Pin Pad/Terminal device and is sent as part of the EMVData in the authorization. The component parses the EMVData to obtain and populate this config.

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multlingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangeul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0