TSYSRetail Class

Properties Methods Events Config Settings Errors

The TSYSRetail class is an advanced tool used to authorize credit cards in a Retail environment, where the customer is purchasing products or services in person. This class makes authorizing these types of transactions very easy. Supported Industry Types include retail stores, restaurants, grocery or food stores, Hotels, Auto Rental businesses and Passenger Transport.

Syntax

TSYSRetail

Remarks

This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSRetail class makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

First, set the merchant properties with setup information acquired from your member bank or processor. For instance:

  Copy
  class.MerchantBankId = "999995"  '(BIN number)
  class.MerchantCategoryCode = "5999"
  class.MerchantName = "test merchant"
  class.MerchantNumber = "123456789012" 
  class.MerchantCity = "Beverly Hills"
  class.MerchantState = "CA"
  class.MerchantStoreNumber = "5999"
  class.MerchantTerminalNumber = "1515"
  class.MerchantZip = "90210"

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount, TransactionNumber, and IndustryType.

  Copy
  class.TransactionAmount = "100"
  class.TransactionNumber = 1
  class.IndustryType = itRetail

Now, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing track1, and for these cards you may use track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with track1 data.

  Copy
  class.CardMagneticStripe = "%B4444333322221111^SMITH/JOHN J         ^031210100000033301000000008000000?"
  class.CardEntryDataSource = edsTrack1

Finally, submit the transaction by calling the Authorize method.

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The Code indicates whether the transaction was approved, and the AVSResult indicates whether the customer's billing address on file with his credit card company matches the information presented in the CustomerAddress and CustomerZip properties. The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the TSYSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


Card	Contains the customer's credit card information.
CardPresent	Indicates whether the current transaction is a card present transaction.
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
IndustryType	Code which indicates the industry the merchant is engaged in.
Merchant	Contains the merchant's setup information.
PrestigiousIndicator	Prestigious Lodging Program indicator for the Hotel Industry Type.
RentalDuration	Duration of an auto rental or hotel stay.
Response	Contains the response to an authorization request.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the class.
TransactionAmount	Purchase amount to be authorized.
TransactionNumber	Sequence number of this transaction.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


AuthenticateCard	Determines only if a card has been lost or stolen.
Authorize	Sends an authorization request.
Config	Sets or retrieves a configuration setting.
GetDetailAggregate	Returns an aggregate containing details of this transaction, which is then used for settlement.
Interrupt	Interrupts the current action.
Reset	Clears all properties to their default values.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
DataPacketIn	Fired when receiving a data packet from the transaction server.
DataPacketOut	Fired when sending a data packet to the transaction server.
Disconnected	Fired when a connection is closed.
Error	Information about errors during data delivery.
Response	Used with Interleaved Transaction Mode.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


AcceptanceDeviceType	Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions.
AccountDataSource	Identifies the source of the customer card data entered.
ACI	Requested Authorization Characteristics Indicator (ACI).
ActivateTerminal	Authenticates a POS device with TSYS.
AllowPartialAuths	Indicates whether partial authorizations are to be supported.
AmexAggregatorName	Amex Payment Service Provider/Aggregator Name.
AmexAirlinePassengerData	Used by Merchants that are in the airline industry to submit information for Passenger Transport transactions.
AmexCNPInternetPhoneData	Used by Merchants in mail-, telephone- and internet-order industries to submit additional data for Card Not Present transactions.
AmexCPGoodsSoldData	Identifies merchandise such as gift cards, computers, and other electronics that can be resold for cash.
AuthenticationCode	An alphanumeric code provided to the POS user for input when authenticating a POS device.
AuthorizationIndicator	The type of authorization request.
BusinessApplicationId	Business Application Identifier (BAI). Visa only.
CanadaDomesticIndicator	Canada Domestic Indicator.
CardholderId	Specifies the method used to verify the identity of the cardholder.
CashOverAmount	The Cash Over amount requested.
ChipConditionCode	The condition code of magnetic stripe read transactions of EMV (chip capable) cards.
CITMITIndicator	CIT/MIT Indicator.
CountryCode	Identifies the country where the merchant is located.
CumulativeAmount	Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only).
CurrencyCode	Identifies the type of currency used by the merchant.
CurrentPendingResponseCount	Current number of pending response packets.
CustomerAddress	Customer's billing address, used for Manually Keyed transactions.
CustomerZip	Zip code portion of the customer's billing address, used for Manually Keyed transactions.
CVV2Option	Verification code.
DeactivateTerminal	Deactivates a POS device with TSYS.
DeviceCode	A 1-character value used to identify the device and type of the merchant submitting the settlement batch.
DisconnectInterleaved	To explicitly terminate the connection.
DoEvents	Processes events from the internal message queue.
DomainServer	Remote domain server indicator.
EMVData	The EMV Data returned from a Pin Pad after reading an EMV card.
EMVOnlineKSN	Clear-text Key Sequence Number for EMV Online PIN transactions.
EMVOnlinePIN	DUKPT DES encrypted PIN block for EMV Online PIN transactions.
GatewayID	A unique value to identify a Gateway or Aggregator.
GenKey	A randomly generated string of alphanumeric characters identifying the terminal.
HeartlandDeviceId	Specifies a device ID to uniquely identify each terminal (card data entry device).
HeartlandEncryptionMode	Specifies the encryption mode to use in Heartland transactions.
HeartlandKeyBlock	Specifies the key block used to encrypt the data.
IncrementalApprovalCode	Transaction Approval Code associated with authorization to increment.
IncrementalRetrievalNumber	Transaction Retrieval Number associated with authorization to increment.
IncrementalTransDate	Transaction Date associated with authorization to increment.
IncrementalTransId	Transaction Id associated with authorization to increment.
IncrementalTransTime	Transaction Time associated with authorization to increment.
InterleavedMode	Determines whether to use Interleaved Transaction Mode for authorization requests.
InterleavedTimeout	Timeout value to wait for a response from TSYS.
IsBalanceInquiry	Indicates that the transaction is a Balance Inquiry transaction.
IsBillPayment	Indicates that the transaction is a bill payment transaction.
IsEstimatedAmount	Specifies whether the amount is an estimate. Visa transactions only.
IsMerchantInitiatedTransaction	Set this to process a Merchant Initiated transaction.
ISOIdentifier	ISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover.
IsPurchaseReturnAuthorization	Set this to process a Purchase Return Authorization transaction.
LaneId	Identifies a terminal at the card acceptor location of acquiring institutions or merchant POS systems.
LocationDetailAddress	Merchant's street address.
LocationDetailCity	Name of the city.
LocationDetailCountry	Country code.
LocationDetailEmail	Merchant's e-mail adress.
LocationDetailName	Merchant name.
LocationDetailPhone	Merchant's phone number.
LocationDetailPostal	Postal code.
LocationDetailRegion	Region code that corresponds to the state, province, or other country subdivision.
MastercardWalletId	Mastercard Wallet Identifier used to identify the Wallet Provider.
MaxPendingResponseCount	Maximum number of pending response packets.
MerchantLanguage	Designates the language that response messages will be returned in.
MerchantSellerID	Merchant's Seller ID.
MessageReasonCode	Code used to identify MIT or Deferred Authorizations for Visa.
MITTransactionId	Transaction Id associated with the original authorization of a Merchant Initiated Transaction.
MobileDeviceType	Identifies the type of mobile device used by the cardholder to initiate the transaction.
MPGID	Merchant Payment Gateway ID.
MSDI	Market Specific Data Indicator.
OriginalAmount	The Original Amount related to a previous Consumer Initiated Transaction (Discover only).
OriginalAmountAccountType	The Account Type of the Original Amount (Discover only).
PFAcquirerInternalReferenceNumber	Acquirer Internal Reference Number (AIRN) (Discover only).
PFForeignRetailerIndicator	The Payment Facilitator Foreign Retailer Indicator (Visa only).
PFIdentifier	The Payment Facilitator/Marketplace Identifier assigned by Visa, MasterCard, or Discover.
PFNameSubMerchantName	The Payment Facilitator Name*Sub-Merchant name.
PFSubMerchantCity	The Payment Facilitator Sub-Merchant City.
PFSubMerchantCountry	The Payment Facilitator Sub-Merchant Country Code.
PFSubMerchantIdentifier	The Payment Facilitator Sub-Merchant Identifier.
PFSubMerchantPostalCode	The Payment Facilitator Sub-Merchant Postal Code.
PFSubMerchantState	The Payment Facilitator Sub-Merchant State/Province Code.
Port	The port to which transactions are posted.
POSDataCode	Specifies the condition of the POS device used at the time of the transaction.
POSEnvironmentIndicator	Provides additional information about the transaction for Visa.
Processor	Specifies the Processor you are connecting to.
RequestToken	Indicates whether to request a token for the specified card data sent in an Authorize request.
ResponseAvailableBalance	Response Available Balance.
ResponseCardholderVerification	Verification results for cardholder identification data (extended AVS).
ResponseCashOverAmount	The Cash Over amount approved.
ResponseEMVData	The EMV Data returned in an authorization response.
ResponseLedgerBalance	Response Ledger Balance.
ResponseMerchantAdviceCode	The Merchant Advice Code returned by Mastercard MIP for declined CNP transactions.
ResponseStoreNumber	Check this field against the original Merchant StoreNumber.
ResponseTerminalNumber	Check this field against the original Merchant TerminalNumber.
ResponseTokenStatus	The status of retrieval of the token.
ResponseTransactionIntegrityClass	A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class.
RetailDepartmentName	Department name.
RetrieveToken	Sends a Token Only request.
Retry	Set this to retry a failed transaction.
SendCommCardInd	Indicates whether to send Commercial Card Request Indicator.
SendExtendedAVS	Specifies whether to send extended AVS data.
Server	The server to which transactions are posted.
ServiceLocationCity	Name of the city where the cardholder received the services.
ServiceLocationCoordinates	Geographic Coordinates of the location where the cardholder received services.
ServiceLocationCountryCode	Country code where the cardholder received the services.
ServiceLocationCountrySubdivision	Region code that corresponds to the state, province, or other country subdivision.
ServiceLocationPostalCode	Postal code where the cardholder received the services.
SpecialConditionIndicator	Describes selected special conditions at the POS.
SurchargeAmount	The transaction fee amount charged to the customer to account for acquirer-assessed surcharge.
TLID	Transaction Link Identifier.
Token	The token received from the TSYS host when a token request is sent.
TransactionStatus	A 1-character value used to indicate the purpose or status of the request.
TransactionTypeIdentifier	Transaction Type Identifier (or Payment Transaction Identifier).
TsysETB	The Encryption Transmission Block TSYS uses to decrypt encrypted data.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Card Property (TSYSRetail Class)

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard* GetCard();
int SetCard(DPaymentsSDKCCCard* val);

int dpaymentssdk_tsysretail_getcardtype(void* lpObj);
int dpaymentssdk_tsysretail_setcardtype(void* lpObj, int iCardType);

char* dpaymentssdk_tsysretail_getcardcvvdata(void* lpObj);
int dpaymentssdk_tsysretail_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

int dpaymentssdk_tsysretail_getcardcvvpresence(void* lpObj);
int dpaymentssdk_tsysretail_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int dpaymentssdk_tsysretail_getcardentrydatasource(void* lpObj);
int dpaymentssdk_tsysretail_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int dpaymentssdk_tsysretail_getcardexpmonth(void* lpObj);
int dpaymentssdk_tsysretail_setcardexpmonth(void* lpObj, int iCardExpMonth);

int dpaymentssdk_tsysretail_getcardexpyear(void* lpObj);
int dpaymentssdk_tsysretail_setcardexpyear(void* lpObj, int iCardExpYear);

int dpaymentssdk_tsysretail_getcardisencrypted(void* lpObj);
int dpaymentssdk_tsysretail_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

char* dpaymentssdk_tsysretail_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_tsysretail_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

char* dpaymentssdk_tsysretail_getcardnumber(void* lpObj);
int dpaymentssdk_tsysretail_setcardnumber(void* lpObj, const char* lpszCardNumber);

int GetCardType();
int SetCardType(int iCardType);

QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);

int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);

QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

This property is not available at design time.

Data Type

DPaymentsSDKCCCard

CardPresent Property (TSYSRetail Class)

Indicates whether the current transaction is a card present transaction.

Syntax

ANSI (Cross Platform)
int GetCardPresent();
int SetCardPresent(int bCardPresent);

Unicode (Windows)
BOOL GetCardPresent();
INT SetCardPresent(BOOL bCardPresent);

int dpaymentssdk_tsysretail_getcardpresent(void* lpObj);
int dpaymentssdk_tsysretail_setcardpresent(void* lpObj, int bCardPresent);

bool GetCardPresent();
int SetCardPresent(bool bCardPresent);

Default Value

TRUE

Remarks

By default, this class handles only retail card-present transactions. However, there are times at which a retail merchant may need to make a card-not-present transaction. For instance, hotel reservations, pre-orders, and the like. By setting this property to False a merchant may submit a card-not-present transaction. However, merchants that deal primarily in card-not-present transactions (either over the Internet or over the telephone) should use the TSYSECommerce class instead.

Data Type

Boolean

CustomerAddress Property (TSYSRetail Class)

The customer's billing address.

Syntax

ANSI (Cross Platform)
char* GetCustomerAddress();
int SetCustomerAddress(const char* lpszCustomerAddress);

Unicode (Windows)
LPWSTR GetCustomerAddress();
INT SetCustomerAddress(LPCWSTR lpszCustomerAddress);

char* dpaymentssdk_tsysretail_getcustomeraddress(void* lpObj);
int dpaymentssdk_tsysretail_setcustomeraddress(void* lpObj, const char* lpszCustomerAddress);

QString GetCustomerAddress();
int SetCustomerAddress(QString qsCustomerAddress);

Default Value

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

This property is an alphanumeric field. Due to concerns with International addresses and changing specifications, the component does not do any processing on the address. The address will be included in the authorization request exactly as you set it.

Per TSYS specs, the following rules apply:

In the address, numbers are not spelled out. "First Street" becomes "1ST Street," "Second" becomes "2ND," and so on.
There must be a (space) between two consecutive data elements that are only numeric.

In order to maximize the address information included in the request, it is suggested that you strip out the spaces (when possible) and punctuations before setting the property.

Note the following examples:

"1234 56th Street" is equivalent to: "1234 56Street"
"1234 56th Street" is NOT equivalent to: "123456Street" //do not strip all spaces between two numbers
"1391 ELM STREET" is equivalent to: "1391ELMSTREET"
"P.O. BOX 24356" is equivalent to: "POBOX24356"

The length of this property is 19 characters, and any string longer than this fails with an error. If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

Data Type

String

CustomerZip Property (TSYSRetail Class)

Customer's zip code (or postal code if outside of the USA).

Syntax

ANSI (Cross Platform)
char* GetCustomerZip();
int SetCustomerZip(const char* lpszCustomerZip);

Unicode (Windows)
LPWSTR GetCustomerZip();
INT SetCustomerZip(LPCWSTR lpszCustomerZip);

char* dpaymentssdk_tsysretail_getcustomerzip(void* lpObj);
int dpaymentssdk_tsysretail_setcustomerzip(void* lpObj, const char* lpszCustomerZip);

QString GetCustomerZip();
int SetCustomerZip(QString qsCustomerZip);

Default Value

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

This field is an alphanumeric field with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.

Data Type

String

IndustryType Property (TSYSRetail Class)

Code which indicates the industry the merchant is engaged in.

Syntax

ANSI (Cross Platform)
int GetIndustryType();
int SetIndustryType(int iIndustryType);

Unicode (Windows)
INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);

Possible Values

SIT_UNKNOWN(0), 
SIT_RETAIL(1), 
SIT_RESTAURANT(2), 
SIT_GROCERY_STORE(3), 
SIT_DIRECT_MARKETING(4), 
SIT_HOTEL(5), 
SIT_AUTO_RENTAL(6), 
SIT_PASSENGER_TRANSPORT(7)

int dpaymentssdk_tsysretail_getindustrytype(void* lpObj);
int dpaymentssdk_tsysretail_setindustrytype(void* lpObj, int iIndustryType);

int GetIndustryType();
int SetIndustryType(int iIndustryType);

Default Value

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.


sitUnknown (0)	Unknown or unsure.
sitRetail (1)	Retail store.
sitRestaurant (2)	Food / Restaurant.
sitGroceryStore (3)	Grocery store or supermarket.
sitDirectMarketing (4)	eCommerce or Direct Marketing
sitHotel (5)	Hotel / Lodging
sitAutoRental (6)	Auto Rental
sitPassengerTransport (7)	Passenger Transport

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

Data Type

Integer

Merchant Property (TSYSRetail Class)

Contains the merchant's setup information.

Syntax

DPaymentsSDKTSYSMerchant* GetMerchant();
int SetMerchant(DPaymentsSDKTSYSMerchant* val);

char* dpaymentssdk_tsysretail_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);

char* dpaymentssdk_tsysretail_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);

char* dpaymentssdk_tsysretail_getmerchantcity(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantcity(void* lpObj, const char* lpszMerchantCity);

char* dpaymentssdk_tsysretail_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);

char* dpaymentssdk_tsysretail_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);

char* dpaymentssdk_tsysretail_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);

char* dpaymentssdk_tsysretail_getmerchantname(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantname(void* lpObj, const char* lpszMerchantName);

char* dpaymentssdk_tsysretail_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

char* dpaymentssdk_tsysretail_getmerchantphone(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);

char* dpaymentssdk_tsysretail_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);

char* dpaymentssdk_tsysretail_getmerchantstate(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantstate(void* lpObj, const char* lpszMerchantState);

char* dpaymentssdk_tsysretail_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);

char* dpaymentssdk_tsysretail_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);

char* dpaymentssdk_tsysretail_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

char* dpaymentssdk_tsysretail_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsysretail_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);

char* dpaymentssdk_tsysretail_getmerchantzip(void* lpObj);
int dpaymentssdk_tsysretail_setmerchantzip(void* lpObj, const char* lpszMerchantZip);

QString GetMerchantBankId();
int SetMerchantBankId(QString qsMerchantBankId);

QString GetMerchantCategoryCode();
int SetMerchantCategoryCode(QString qsMerchantCategoryCode);

QString GetMerchantCity();
int SetMerchantCity(QString qsMerchantCity);

QString GetMerchantCountryCode();
int SetMerchantCountryCode(QString qsMerchantCountryCode);

QString GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(QString qsMerchantCurrencyCode);

QString GetMerchantLanguage();
int SetMerchantLanguage(QString qsMerchantLanguage);

QString GetMerchantName();
int SetMerchantName(QString qsMerchantName);

QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

QString GetMerchantPhone();
int SetMerchantPhone(QString qsMerchantPhone);

QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone);

QString GetMerchantState();
int SetMerchantState(QString qsMerchantState);

QString GetMerchantStoreNumber();
int SetMerchantStoreNumber(QString qsMerchantStoreNumber);

QString GetMerchantStreetAddress();
int SetMerchantStreetAddress(QString qsMerchantStreetAddress);

QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);

QString GetMerchantTimeZone();
int SetMerchantTimeZone(QString qsMerchantTimeZone);

QString GetMerchantZip();
int SetMerchantZip(QString qsMerchantZip);

Remarks

This property must be set to an instance of the TSYSMerchant type, which will contain information to identify the merchant to the TSYS processing server. Please see the TSYSMerchant type for a list of available fields.

Data Type

DPaymentsSDKTSYSMerchant

PrestigiousIndicator Property (TSYSRetail Class)

Prestigious Lodging Program indicator for the Hotel Industry Type.

Syntax

ANSI (Cross Platform)
int GetPrestigiousIndicator();
int SetPrestigiousIndicator(int iPrestigiousIndicator);

Unicode (Windows)
INT GetPrestigiousIndicator();
INT SetPrestigiousIndicator(INT iPrestigiousIndicator);

Possible Values

PI_NOT_PARTICIPATING(0), 
PI_500LIMIT(1), 
PI_1000LIMIT(2), 
PI_1500LIMIT(3)

int dpaymentssdk_tsysretail_getprestigiousindicator(void* lpObj);
int dpaymentssdk_tsysretail_setprestigiousindicator(void* lpObj, int iPrestigiousIndicator);

int GetPrestigiousIndicator();
int SetPrestigiousIndicator(int iPrestigiousIndicator);

Default Value

Remarks

This indicator is used by participants in Visa's Prestigious Lodging Program. A transaction amount of "100" should be entered in the request if the merchant wishes the transaction to participate in the Visa Prestigious Property Program. Valid indicators include:


piNotParticipating (0)	Non-Participating Property
pi500Limit (1)	Prestigious Property with $500 Limit
pi1000Limit (2)	Prestigious Property with $1000 Limit
pi1500Limit (3)	Prestigious Property with $1500 Limit

This property is only valid for the Hotel IndustryType and will be ignored for all other industries.

Data Type

Integer

RentalDuration Property (TSYSRetail Class)

Duration of an auto rental or hotel stay.

Syntax

ANSI (Cross Platform)
int GetRentalDuration();
int SetRentalDuration(int iRentalDuration);

Unicode (Windows)
INT GetRentalDuration();
INT SetRentalDuration(INT iRentalDuration);

int dpaymentssdk_tsysretail_getrentalduration(void* lpObj);
int dpaymentssdk_tsysretail_setrentalduration(void* lpObj, int iRentalDuration);

int GetRentalDuration();
int SetRentalDuration(int iRentalDuration);

Default Value

Remarks

This property indicates the anticipated length of a hotel stay or auto rental. This field must be in the range of 1 to 99, and should be set to 1 for no-show authorizations. For advanced lodging deposits and auto rental pre-pays, this property should reflect the number of days being paid for in the advanced payment.

Data Type

Integer

Response Property (TSYSRetail Class)

Contains the response to an authorization request.

Syntax

DPaymentsSDKTSYSResponse* GetResponse();

char* dpaymentssdk_tsysretail_getresponseapprovalcode(void* lpObj);

char* dpaymentssdk_tsysretail_getresponseauthorizedamount(void* lpObj);

char* dpaymentssdk_tsysretail_getresponseauthsource(void* lpObj);

char* dpaymentssdk_tsysretail_getresponseavsresult(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsecardlevel(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsecode(void* lpObj);

int dpaymentssdk_tsysretail_getresponsecommercialcardtype(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsecvvresult(void* lpObj);

char* dpaymentssdk_tsysretail_getresponseretrievalnumber(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsereturnedaci(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsetext(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsetransactiondate(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsetransactionid(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsetransactionnumber(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsetransactiontime(void* lpObj);

char* dpaymentssdk_tsysretail_getresponsevalidationcode(void* lpObj);

QString GetResponseApprovalCode();

QString GetResponseAuthorizedAmount();

QString GetResponseAuthSource();

QString GetResponseAVSResult();

QString GetResponseCardLevel();

QString GetResponseCode();

int GetResponseCommercialCardType();

QString GetResponseCVVResult();

QString GetResponseRetrievalNumber();

QString GetResponseReturnedACI();

QString GetResponseText();

QString GetResponseTransactionDate();

QString GetResponseTransactionId();

QString GetResponseTransactionNumber();

QString GetResponseTransactionTime();

QString GetResponseValidationCode();

Remarks

This property will contain the response returned from the TSYS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The TSYSResponse type contains the following fields:


ApprovalCode	Contains an authorization code for approved transactions, or a description of the error for declines.
AuthorizedAmount	Amount actually used from the card (used when supporting partial redemptions).
AuthSource	Indicates the source of the authorization code stored in ApprovalCode.
AVSResult	Contains the Address Verification System result code.
CardLevel	This field contains a two-character code created by Visa during the authorization process.
Code	Indicates the status of the authorization request.
CommercialCardType	Indicates whether the credit card charged is a corporate commercial card (and if so the type of commercial card).
CVVResult	Contains the returned CVV result code (if CVV data was sent in the request).
RetrievalNumber	This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
ReturnedACI	Returned Authorization Characteristics Indicator contains CPS qualification status.
Text	Text information that describes each response code.
TransactionDate	Local transaction date returned from the server in MMDDYY format.
TransactionId	Contains the Transaction Identifier or MasterCard Reference Number.
TransactionNumber	Check this field against the TransactionNumber sent in the authorization.
TransactionTime	Local transaction time returned from the server in HHMMSS format.
ValidationCode	Additional information generated by the card issuer.

This property is read-only.

Data Type

DPaymentsSDKTSYSResponse

SSLAcceptServerCert Property (TSYSRetail Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

DPaymentsSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_tsysretail_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_tsysretail_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysretail_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysretail_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_tsysretail_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_tsysretail_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_tsysretail_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_tsysretail_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_tsysretail_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_tsysretail_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_tsysretail_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_tsysretail_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_tsysretail_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_tsysretail_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysretail_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

DPaymentsSDKCertificate

SSLCert Property (TSYSRetail Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

DPaymentsSDKCertificate* GetSSLCert();
int SetSSLCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_tsysretail_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertissuer(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_tsysretail_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysretail_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysretail_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsysretail_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_tsysretail_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsysretail_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_tsysretail_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsysretail_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_tsysretail_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertusage(void* lpObj);

int dpaymentssdk_tsysretail_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertversion(void* lpObj);

char* dpaymentssdk_tsysretail_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsysretail_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_tsysretail_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsysretail_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

DPaymentsSDKCertificate

SSLProvider Property (TSYSRetail Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_tsysretail_getsslprovider(void* lpObj);
int dpaymentssdk_tsysretail_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (TSYSRetail Class)

The server certificate for the last established connection.

Syntax

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_tsysretail_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_tsysretail_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysretail_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysretail_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dpaymentssdk_tsysretail_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_tsysretail_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertusage(void* lpObj);

int dpaymentssdk_tsysretail_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertversion(void* lpObj);

char* dpaymentssdk_tsysretail_getsslservercertsubject(void* lpObj);

int dpaymentssdk_tsysretail_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DPaymentsSDKCertificate

Timeout Property (TSYSRetail Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_tsysretail_gettimeout(void* lpObj);
int dpaymentssdk_tsysretail_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionAmount Property (TSYSRetail Class)

Purchase amount to be authorized.

Syntax

ANSI (Cross Platform)
char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount);

Unicode (Windows)
LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);

char* dpaymentssdk_tsysretail_gettransactionamount(void* lpObj);
int dpaymentssdk_tsysretail_settransactionamount(void* lpObj, const char* lpszTransactionAmount);

QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);

Default Value

Remarks

This field contains the transaction amount to be authorized. The transaction amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode. In the United States, the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

TransactionNumber Property (TSYSRetail Class)

Sequence number of this transaction.

Syntax

ANSI (Cross Platform)
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Unicode (Windows)
INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);

int dpaymentssdk_tsysretail_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsysretail_settransactionnumber(void* lpObj, int iTransactionNumber);

int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Default Value

Remarks

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the TransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.

Data Type

Integer

AuthenticateCard Method (TSYSRetail Class)

Determines only if a card has been lost or stolen.

Syntax

ANSI (Cross Platform)
int AuthenticateCard();

Unicode (Windows)
INT AuthenticateCard();

int dpaymentssdk_tsysretail_authenticatecard(void* lpObj);

int AuthenticateCard();

Remarks

This method does not send an authorization, but instead it sends an authentication request. If successful the Code will be "85". If the card is stolen or otherwise not normal, the Code and Text will indicate such. You may send AVS (CustomerAddress and CustomerZip) as well as CVVData, and the AVSResult and CVVResult will be returned as normal.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Authorize Method (TSYSRetail Class)

Sends an authorization request.

Syntax

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int dpaymentssdk_tsysretail_authorize(void* lpObj);

int Authorize();

Remarks

This method sends an authorization request to the Vital/TSYS transaction server. If the authorization request was successful, the Code property will contain "00" or "85".

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the Settlement class. For example:

  Copy
TSYSRetail.Authorize()
TSYSSettle.DetailRecordCount = 1
TSYSSettle.DetailRecordAggregate(0) = TSYSRetail.GetDetailAggregate()

Error Handling (C++)

Config Method (TSYSRetail Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_tsysretail_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These 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.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetDetailAggregate Method (TSYSRetail Class)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

ANSI (Cross Platform)
char* GetDetailAggregate();

Unicode (Windows)
LPWSTR GetDetailAggregate();

char* dpaymentssdk_tsysretail_getdetailaggregate(void* lpObj);

QString GetDetailAggregate();

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

An example of how this method is used is shown below:

  Copy
	TSYSRetail.Authorize()
	TSYSSettle.DetailRecordCount = 1    
	TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()

Error Handling (C++)

Interrupt Method (TSYSRetail Class)

Interrupts the current action.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_tsysretail_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts any processing that the class is currently executing.

Error Handling (C++)

Reset Method (TSYSRetail Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsysretail_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

Connected Event (TSYSRetail Class)

Fired immediately after a connection completes (or fails).

Syntax

ANSI (Cross Platform)
virtual int FireConnected(TSYSRetailConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} TSYSRetailConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(TSYSRetailConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} TSYSRetailConnectedEventParams;

#define EID_TSYSRETAIL_CONNECTED 1

virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class TSYSRetailConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(TSYSRetailConnectedEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireConnected(TSYSRetailConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

DataPacketIn Event (TSYSRetail Class)

Fired when receiving a data packet from the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketIn(TSYSRetailDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} TSYSRetailDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(TSYSRetailDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} TSYSRetailDataPacketInEventParams;

#define EID_TSYSRETAIL_DATAPACKETIN 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class TSYSRetailDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(TSYSRetailDataPacketInEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireDataPacketIn(TSYSRetailDataPacketInEventParams *e) {...}

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (TSYSRetail Class)

Fired when sending a data packet to the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketOut(TSYSRetailDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} TSYSRetailDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(TSYSRetailDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} TSYSRetailDataPacketOutEventParams;

#define EID_TSYSRETAIL_DATAPACKETOUT 3

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class TSYSRetailDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(TSYSRetailDataPacketOutEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireDataPacketOut(TSYSRetailDataPacketOutEventParams *e) {...}

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (TSYSRetail Class)

Fired when a connection is closed.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnected(TSYSRetailDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} TSYSRetailDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(TSYSRetailDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} TSYSRetailDisconnectedEventParams;

#define EID_TSYSRETAIL_DISCONNECTED 4

virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class TSYSRetailDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(TSYSRetailDisconnectedEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireDisconnected(TSYSRetailDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.

Please refer to the Error Codes section for more information.

Error Event (TSYSRetail Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(TSYSRetailErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} TSYSRetailErrorEventParams;


Unicode (Windows)
virtual INT FireError(TSYSRetailErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} TSYSRetailErrorEventParams;

#define EID_TSYSRETAIL_ERROR 5

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TSYSRetailErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TSYSRetailErrorEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireError(TSYSRetailErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Response Event (TSYSRetail Class)

Used with Interleaved Transaction Mode.

Syntax

ANSI (Cross Platform)
virtual int FireResponse(TSYSRetailResponseEventParams *e);

typedef struct {
  const char *TransactionId;
  const char *ResponseCode;
  const char *ResponseText;
  const char *ResponseApprovalCode;
  int reserved;
} TSYSRetailResponseEventParams;


Unicode (Windows)
virtual INT FireResponse(TSYSRetailResponseEventParams *e);

typedef struct {
  LPCWSTR TransactionId;
  LPCWSTR ResponseCode;
  LPCWSTR ResponseText;
  LPCWSTR ResponseApprovalCode;
  INT reserved;
} TSYSRetailResponseEventParams;

#define EID_TSYSRETAIL_RESPONSE 6

virtual INT DPAYMENTSSDK_CALL FireResponse(LPSTR &lpszTransactionId, LPSTR &lpszResponseCode, LPSTR &lpszResponseText, LPSTR &lpszResponseApprovalCode);

class TSYSRetailResponseEventParams {
public:
  const QString &TransactionId();

  const QString &ResponseCode();

  const QString &ResponseText();

  const QString &ResponseApprovalCode();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Response(TSYSRetailResponseEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireResponse(TSYSRetailResponseEventParams *e) {...}

Remarks

When InterleavedMode configuration setting is set to True the component will send interleaved transactions without blocking and waiting for a response. For every response that the class receives from TSYS the Response event will fire. TransactionId parameter can be used to identify the transaction. ResponseCode and ResponseText can be used to determine if a transaction was approved or declined.

SSLServerAuthentication Event (TSYSRetail Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(TSYSRetailSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} TSYSRetailSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(TSYSRetailSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} TSYSRetailSSLServerAuthenticationEventParams;

#define EID_TSYSRETAIL_SSLSERVERAUTHENTICATION 7

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class TSYSRetailSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(TSYSRetailSSLServerAuthenticationEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireSSLServerAuthentication(TSYSRetailSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (TSYSRetail Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(TSYSRetailSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} TSYSRetailSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(TSYSRetailSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} TSYSRetailSSLStatusEventParams;

#define EID_TSYSRETAIL_SSLSTATUS 8

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class TSYSRetailSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(TSYSRetailSSLStatusEventParams *e);

// Or, subclass TSYSRetail and override this emitter function.
virtual int FireSSLStatus(TSYSRetailSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

CCCard Type

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard (declared in dpaymentssdk.h)

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields

  Copy
CCCard card = new CCCard();
card.MagneticStripe = "B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A";
card.EntryDataSource = edsTrack1;

Example: Using a Constructor

  Copy
CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields

  Copy
CCCard card = new CCCard();
card.Number = "4788250000028291";
card.ExpMonth = 12;
card.ExpYear = 2010;
card.EntryDataSource = edsManualEntryNoCardReader;

Example: Using a Constructor

  Copy
CCCard card = new CCCard("4012000033330026", 04, 2009);

Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will fails with an error because none is present.

The following fields are available:

CardType
CVVData
CVVPresence
EntryDataSource
ExpMonth
ExpYear
IsEncrypted
MagneticStripe
Number

Fields

CardType
int
Default Value: 0

Type of credit card being used in this transaction. This field contains the customer's credit card type. This is automatically computed after the Number is set, but it can also be changed manually. A list of valid card types is included below.


ctUnknown (0)	Invalid or unknown prefix, card type not known.
ctVisa (1)	Visa or Delta Card.
ctMasterCard (2)	MasterCard.
ctAMEX (3)	American Express Card.
ctDiscover (4)	Discover Card.
ctDiners (5)	Diners Club or Carte Blanche Card.
ctJCB (6)	JCB Card.
ctVisaElectron (7)	Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8)	Maestro Card
ctLaser (10)	Laser Card (Ireland)

CVVData
char*
Default Value: ""

Three digit security code on back of card (optional).

This alphanumeric field contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional field which can be used to determine if the customer is actually in possession of the credit card.

Even if the CVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult field and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CVVPresence will be automatically set to cvpProvided. If set to empty string (""), CVVPresence will be automatically set to cvpNotProvided.

CVVPresence
int
Default Value: 0

Indicates the presence of the card verification value.

This field is used to indicate the presence of CVVData.

The class will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence indicator by setting this property.

Available values are:

cvpNotProvided (0)
cvpProvided (1)
cvpIllegible (2)
cvpNotOnCard (3)

EntryDataSource
int
Default Value: 0

This field contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this field.


edsTrack1 (0)	Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1)	Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2)	Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)	Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)	Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)	Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)	Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)	Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).
edsIVR (8)	Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (Number, ExpMonth, and ExpYear are sent).
edsKiosk (9)	Automated kiosk transaction. Track1 or Track2 data must be sent in MagneticStripe, the transaction cannot be manually entered.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.


TSYSHCBenefit	edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable
TSYSHCECommerce	edsManualEntryNoCardReader
TSYSHCRetail	edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

ExpMonth
int
Default Value: 1

Expiration month of the credit card specified in Number.

This field contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

ExpYear
int
Default Value: 2000

Expiration year of the credit card specified in Number.

This field contains the expiration date of the customer's credit card. This field must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

IsEncrypted
int
Default Value: FALSE

Determines whether data set to the Number or MagneticStripe fields is validated.

By default, when the Number or MagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be parsed for the track specified by EntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the Number or MagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

MagneticStripe
char*
Default Value: ""

Track data read off of the card's magnetic stripe.

If EntryDataSource is not one of the manually entered enumerations, then this field must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this field with track 1 or track 2 data, and may not pass both. Use the EntryDataSource field to indicate which track you are sending.

The following example shows how to set the MagneticStripe and EntryDataSource fields if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

  Copy
class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
class.CardEntryDataSource = edsTrack1

or

class.CardMagneticStripe = "4788250000028291=05121015432112345678"
class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

Number
char*
Default Value: ""

Customer's credit card number for the transaction.

If you're sending the transaction with MagneticStripe data, this field should be left empty.

Constructors

CCCard()

CCCard(const char* lpszNumber, int iExpMonth, int iExpYear)

CCCard(const char* lpszMagneticStripe, int iEntryDataSource)

Certificate Type

This is the digital certificate being used.

Syntax

DPaymentsSDKCertificate (declared in dpaymentssdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
char*
Default Value: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: C# Copy `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the field is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

TSYSMerchant Type

Contains the merchant's setup information.

Syntax

DPaymentsSDKTSYSMerchant (declared in dpaymentssdk.h)

Remarks

This type contains the merchant's setup information. This includes the merchant identification, bank routing information, language, location, and other fields that identify the merchant to the TSYS server. Some of the information in these fields will be included on the customer's credit card statement, such as the merchant's Name, State, ServicePhone, etc.

The following fields are available:

BankId
CategoryCode
City
CountryCode
CurrencyCode
Language
Name
Number
Phone
ServicePhone
State
StoreNumber
StreetAddress
TerminalNumber
TimeZone
Zip

Fields

BankId
char*
Default Value: ""

The number which identifies the merchant's bank or processor.

This field contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This field may not remain zero-filled.

Note, the TSYS Server uses the Merchant's BankId and Number to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

CategoryCode
char*
Default Value: ""

Classifies a merchant by the type of store.

This four digit field contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).

City
char*
Default Value: ""

Merchant's City

For Retail (Card Present) transactions, this field should contain the city in which the merchant is located. This is an optional field. However if it is specified, the Name and State must also be specified.

Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this field is ignored. ServicePhone is used for those industries instead of City (this does not apply to MasterCard).

Note: This field must contain the same data used in the batch settlement. The first character of this field may not be a space. This field may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this field is 13 characters.

CountryCode
char*
Default Value: "840"

Identifies the country where the merchant is located.

This field contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".

CurrencyCode
char*
Default Value: "840"

Identifies the type of currency used by the merchant.

This field contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

Language
char*
Default Value: "00"

Designates the language that response messages will be returned in.

This field contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This field may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.


Indicator	Language
00	English.
01	Spanish.
02	Portuguese.
03	Reserved for Irish.
04	Reserved for French.
05	Reserved for German.
06	Reserved for Italian.
07	Reserved for Dutch.

Name
char*
Default Value: ""

Name of the merchant.

This 25 character field contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this field may not be a space. This field must contain the same value in both authorization and batch settlement.

This is an optional field. However if this field is specified, the State and City (Retail) or State and ServicePhone (E-Commerce) must also be specified.

This field may contain alphanumeric and punctuation characters. The maximum length of this field is 25 characters.

Number
char*
Default Value: ""

A unique number used to identify the merchant within the VisaNet system.

This 12 digit field contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.

Phone
char*
Default Value: ""

Merchant's phone number.

This field contains the Merchant's business phone number. This can be the same as the customer service phone number.

ServicePhone
char*
Default Value: ""

Merchant's customer service number.

This field contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This field is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

State
char*
Default Value: ""

State or province that the merchant is located in.

This two character field contains the merchant state or province provided by the signing member or processor. This field must contain the same data used in the batch settlement.

This is an optional field. However if it is specified the Merchant Name and City (Retail) or Name and ServicePhone (E-Commerce) must also be specified.

StoreNumber
char*
Default Value: ""

Used to identify a specific merchant's store within the VisaNet system.

This four digit field contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This field must be right-justified and zero-filled.

StreetAddress
char*
Default Value: ""

Merchant's street address.

This 25 character field contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.

TerminalNumber
char*
Default Value: ""

Used to identify a unique terminal within a merchant location.

This four digit field contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This field must be right-justified and zero-filled.

TimeZone
char*
Default Value: "705"

Specifies the GMT offset used to calculate the local time within the VisaNet system.

This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.

Byte #1:


Value	Meaning
0	Positive offset, in hours, ahead of GMT.
1	Negative offset, in hours, behind GMT.
2	Positive offset, in 15 minute increments, ahead of GMT.
3	Negative offset, in 15 minute increments, behind GMT.
4	Positive offset, in 15 minute increments, ahead of GMT, in cities participating in daylight savings.
5	Negative offset, in 15 minute increments, behind GMT, in cities participating in daylight savings.
6	Positive offset, in hours, ahead of GMT, in cities participating in daylight savings.
7	Negative offset, in hours, behind GMT, in cities participating in daylight savings.
8-9	RESERVED.

Bytes #2-3:

If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.

Zip
char*
Default Value: ""

Zip code where the merchant that initiated this transaction is located.

This field contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this field will be assigned by the signing member or processor.

This field is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the field is set.

Constructors

TSYSMerchant()

TSYSResponse Type

Contains the response to the authorization.

Syntax

DPaymentsSDKTSYSResponse (declared in dpaymentssdk.h)

Remarks

This type contains the results of a transaction made with the TSYSECommerce or TSYSRetail class. The fields contained by this type are listed below.

The following fields are available:

ApprovalCode
AuthorizedAmount
AuthSource
AVSResult
CardLevel
Code
CommercialCardType
CVVResult
RetrievalNumber
ReturnedACI
Text
TransactionDate
TransactionId
TransactionNumber
TransactionTime
ValidationCode

Fields

ApprovalCode
char* (read-only)
Default Value: ""

Contains an authorization code when a transaction has been approved.

This six character field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction has not been approved, then the contents of the field should be ignored. The ApprovalCode must be stored and submitted in the settlement data capture record.

AuthorizedAmount
char* (read-only)
Default Value: ""

Amount actually used from the card (used when supporting partial redemptions).

The AuthorizedAmount represents the actual approved transaction amount when a transaction request is received from a client using the PartialRedemption option. If PartialAuthorization is set to True, then AuthorizedAmount will be the amount of the TransactionAmount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.

For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the PartialAuthorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the AuthorizedAmount will represent the approved amount of $7.50.In this case, the Code will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the AuthorizedAmount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the TransactionAmount) then this field will be "0" or "".

If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialAuthorization.

AuthSource
char* (read-only)
Default Value: ""

Indicates the source of the authorization code stored in ApprovalCode.

This field contains a one character code indicating the source of the ApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes are:


Code	Description
6	Off-line approval: POS device generated.
7	Acquirer approval.
9	Use for non-authorized transactions; such as credit card credits
B	Response provided by Visa Transaction Advisor Service.
E	Off-line approval: authorization code manually keyed.
F	CAFIS-generated response: Post-Auth.*
G	Issuer Approval: Post-Auth.*
H	Exceeds acquirer settlement risk exposure cap.
N	No authorization required: Below floor limit
L	Late clearing - authorization previously obtained (clearing beyond 30 days)
V	Authorization obtained via VisaNet (Issuer or STIP response)
Space	Default value, if acquirer cannot define it (MC, D, AX)

* Currently in use by Japan Acquirer Services (JAS).

AVSResult
char* (read-only)
Default Value: ""

Contains the Address Verification System result code.

This one character field contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:


Code	Description
0	Approved/Declined - Address verification was not requested or it was requested but the transaction was declined (Visa, MC, Amex, Discover).
A	Address Match - CustomerAddress matches, CustomerZip does not, or the request does not include the CustomerZip (Visa, Amex, Discover).
I*	Ver Unavailable - Address information not verified (Discover).
N	No match - Transaction contained postal/ZIP code only, or street address only, or postal code and street address. Also used when transaction requests AVS but sends no AVS data (Visa, MC, Amex, Discover).
R	Retry - System unable to process (Visa, MC, Amex, Discover).
S	Serv Unavailable - Service not supported (MC, Amex, Discover).
U	Ver Unavailable - No data from Issuer/Authorization platform (Visa, MC, Amex, Discover).
W	Zip Match - Nine character CustomerZip matches, CustomerAddress does not (MC, Discover).
X	Exact Match - Nine character CustomerZip and CustomerAddress match (MC, Discover).
Y	Exact Match - CustomerZip and CustomerAddress match (Visa, MC, Amex, Discover).
Z	Zip Match - CustomerZip matches; CustomerAddress does not match or street address not included in the request (Visa, MC, Amex, Discover).
1	APPROVAL - Cardholder name and ZIP match (Amex only).
2	APPROVAL - Cardholder name, address, and ZIP match (Amex only).
3	APPROVAL - Cardholder name, address match (Amex only).
4	APPROVAL - Cardholder name matches (Amex only).
5	APPROVAL - Cardholder name incorrect, ZIP matches (Amex only).
6	APPROVAL - Cardholder name incorrect, address and ZIP match (Amex only).
7	APPROVAL - Cardholder name incorrect, address matches (Amex only).
8	NO MATCH - Cardholder name, address, and ZIP do not match (Amex only).

*AVS Result Code for International addresses only

CardLevel
char* (read-only)
Default Value: ""

This field contains a two-character code created by Visa during the authorization process.

The current list of possible return values can be found in the table of contents.

Code
char* (read-only)
Default Value: ""

Indicates the status of the authorization request.

This field contains a two character response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the Text to determine nature of a response message. A response code of "00" represents an approval. A response code of "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

A list of valid result Codes are listed in the table of contents.

CommercialCardType
int (read-only)
Default Value: 0

Response field that indicates whether the card is a commercial card.

If you wish to support Corporate Purchasing Cards with Level II or Level III data, you should inspect the value of this field after a successful authorization. If the Vital/TSYS host indicates that the authorized card is a commercial card, you may use the TSYSLevel2 or TSYSLevel3 classs to add the extra data required during settlement.

Possible values for this field include:


tccNotCommercial (0)	Not a commercial card. You must not send Level II or Level III data in the settlement.
tccBusinessCard (1)	Business Card
tccVisaCommerce (2)	Visa Commerce (Reserved for future use)
tccCorporateCard (3)	Corporate Card
tccPurchaseCard (4)	Purchasing Card

Note: Of the possible CommercialCardTypes for Visa cards, you should only send Level III data for tctPurchaseCards. Level III may be sent for any MasterCard CommercialCardType except cctNotCommercial.

This field is only valid after a successful authorization request and response.

CVVResult
char* (read-only)
Default Value: ""

Contains the returned CVV result code if it was requested.

If a CVV value was sent in the authorization request, then this one character field will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CVV data is included in the authorization. Instead, an AMEX transaction will be declined if the CVV value does not match, with an Text indicating such. The following is a list of current result codes:


M	CVV2 match.
N	CVV2 no match.
P	Not processed.
S	Merchant has indicated that CVV2 is not present on card.
U	Issuer not certified and/or has not provided Visa encryption keys.

RetrievalNumber
char* (read-only)
Default Value: ""

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

This field contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.

ReturnedACI
char* (read-only)
Default Value: ""

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the TransactionId or ValidationCode fields.

Text
char* (read-only)
Default Value: ""

Text information that describes each response code.

This field contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.

The English-language response text messages are listed in the table of contents.

TransactionDate
char* (read-only)
Default Value: ""

Local transaction date returned from the server in MMddyy format.

This six digit field contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This field should be recorded and submitted in the Batch Settlement.

TransactionId
char* (read-only)
Default Value: ""

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character field can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.

TransactionNumber
char* (read-only)
Default Value: ""

Check this field against the original Transaction Number.

This field should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this field should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

TransactionTime
char* (read-only)
Default Value: ""

Local transaction time returned from the server in HHmmss format.

This six digit field contains the Local Transaction Time returned by the authorizing system. This field should be recorded and submitted in the Batch Settlement.

ValidationCode
char* (read-only)
Default Value: ""

This optional field contains information generated by the card issuer.

This optional four character field contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field should be recorded and submitted as part of a Batch Settlement.

Constructors

TSYSResponse()

Config Settings (TSYSRetail Class)

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.

TSYSRetail Config Settings

AcceptanceDeviceType: Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions.

This 1-character configuration setting is used to identify the type of device used by the merchant for accepting mobile Point of Sale (mPOS) transactions. Valid values are:


Value	Description
0	Dedicated mPOS Terminal with PCI compliant dongle (with or without key pad)
1	Off the Shelf Mobile Device
2	Dongle with software-based application that supports PIN entry on glass
3	Off the Shelf Mobile Device with software-based application that supports PIN entry on glass
M	Mobile POS Add-On Hardware
T	Tap on Mobile No Add-On Hardware

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

This field is sent in the request based on the EntryDataSource 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.

ACI: Requested Authorization Characteristics Indicator (ACI).

By default the class automatically selects the correct ACI for the type of transaction being attempted. This configuration setting is for advanced users, and it is not recommended it be changed. That being said, this 1-character field contains the Requested ACI used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. If a merchant chooses not to participate in CPS, the ACI may be set to "N". The following table provides a summary of the codes currently supported by both Visa and MasterCard. Please note that not all of these ACI values are supported in Direct Marketing and Retail transactions.


N	Device is not CPS capable / MasterCard TIPS (Travel Industries Premiere Service).
Y	Device is CPS capable.
P	CPS Capable - Manually keyed hotel/lodging transaction or preferred customer authorization request for hotel, auto rental, and passenger transport industries.
I	CPS capable - Incremental Authorization Request.
R	Recurring or Installment payments / MasterCard SIIP (Recurring payment).

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 Zip and/or ServicePhone, to perform authentication. After a POS device is successfully authenticated, GenKey will be populated.

AllowPartialAuths: Indicates whether partial authorizations are to be supported.

When this setting is True, if the credit card being authorized does not contain sufficient funds to cover the TransactionAmount, the card will not be declined. Instead, the transaction will be authorized for a lesser amount. The customer must then use another form of payment to make up the remainder. The total amount authorized by TSYS will be returned in the ResponseAuthorizedAmount configuration setting. For instance, if the TransactionAmount is $100.00, but the card only has a $50.00 balance, the card is charged for $50.00, and the ResponseAuthorizedAmount will be "50.00". The merchant may then collect the remaining $50 in cash, check, credit card, or any other acceptable form of payment. This setting is False by default.

AmexAggregatorName: Amex Payment Service Provider/Aggregator Name.

This field is used for American Express transactions that are submitted via an Aggregator, Payment Service Provider or Facilitator to identify the Aggregator's Name. The maximum length of this field is 20 characters. It must be upper-case and should not contain spaces.

AmexAirlinePassengerData: Used by Merchants that are in the airline industry to submit information for Passenger Transport transactions.

This configuration setting takes a vertical bar (|) 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:

  Copy
TSYSECommerce.Config("AmexAirlinePassengerData=DepartureDate=20170601|PassengerName=FROST~JANE~M~MRS|CardMemberName=FROST~CHARLES~F~MR|Origin=ABC|Destination=DEF|NumberOfCities=4|RoutingCities=ABC/DEF/GHI/JKL|NumberOfAirlineCarriers=3|AirlineCarriers=AB/XY/BC|FareBasis=ABC123DEF456GHI789JKL012|NumberOfPassengers=1|ETicket=True|ReservationCode=ABCDE1234567890");

NOTE: The tilde character "~" = character space.

DepartureDate

Passenger's departure date in format YYYYMMDD. Example: 20171220

PassengerName

Passenger Name in format SURNAME~FIRSTNAME~MIDDLEINITIAL~TITLE. Use character space as sub-element separator. Example: FROST JANE M MRS

CardMemberName

Cardmember Name in format SURNAME~FIRSTNAME~MIDDLEINITIAL~TITLE. Use character space as sub-element separator. Example: FROST CHARLES F MR

Origin

First segment travel origination Airport. Example for Los Angeles (CA): LAX

Destination

Destination Airport for first travel segment of trip; not necessarily the final destination. For example, if passenger flies from STL to MIA with layover at JFK, Destination Airport for first segment is JFK.

NumberOfCities

Number of Airports or Cities on ticket. Maximum is 10.

RoutingCities

Routing Airport or City Codes for each leg on ticket (including Origin and Destination) in segments with virgule (/) separator. Example: ABC/DEF/GHI/JKL/MNO/PQR/STU/VWX/YZA/XYZ. Note that the minimum number of RoutingCitites is 2 (Origin and Destination).

NumberOfAirlineCarriers

Number of Airline Carriers entered in AirlineCarriers subfield. Maximum is 9.

AirlineCarriers

Airline Carrier Code for each leg on ticket (including Origin and Destination) in segments with virgule (/) separator. Example: AB/XY/BC/CD/DE/DE/CD/BC/AB. Note: Each leg must have Airline Carrier Code entry, even if multiple (or all) legs are on the same Airline. Note that the minimum number of AirlineCarriers is 1 (Airline Carrier Code from Origin to Destination).

FareBasis

Primary and secondary discount codes which indicate class of service and fare level associated with ticket. Example: ABC123DEF456GHI789JKL012

NumberOfPassengers

Number of passengers in party. Default value is 1.

ETicket

Indicates if ticket is electronic. Default value is false. Possible values:


True	Electronic Ticket
False	Other ticket types (non-electronic ticket) (default)

ReservationCode

A precursor to a ticket number which corresponds to an airline ticket purchase reservation made by an airline or Global Distribution System (GDS). Example: ABCDE1234567890

AmexCNPInternetPhoneData: Used by Merchants in mail-, telephone- and internet-order industries to submit additional data for Card Not Present transactions.

Code Example:

  Copy
TSYSECommerce.Config("AmexCNPInternetPhoneData=CustomerEmail=CFFROST@EMAILADDRESS.COM|CustomerHostName=PHX.QW.AOL.COM|BrowserType=MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~WINDOWS~95)|ShipToCountry=840|ShippingMethod=02|ProductSKU=TKDC315U|CustomerIP=127.142.005.056|CustomerANI=6025551212|CustomerIIDigits=00");

CustomerEmail

Customer's e-mail address.

CustomerHostName

Name of the server that the customer is connected to.

BrowserType

Customer's HTTP browser type.

ShipToCountry

Three-byte, numeric country code. Example for USA: 840

ShippingMethod

Two-byte, shipment-type code. Possible values:


01	Same Day
02	Overnight / Next Day
03	Priority, 2-3 days
04	Ground, 4 or more days
05	Electronic Delivery
06	Ship to Store

ProductSKU

Unique SKU (Stock Keeping Unit) inventory reference number of product associated with this authorization request. For multiple items, enter the SKU for the single, most expensive item.

CustomerIP

Customer's Internet IP address.

CustomerANI

ANI (Automatic Number Identification) specified phone number that customer used to place order with merchant.

CustomerIIDigits

Telephone company-provided ANI ii (Information Identifier) coding digits associated with CUSTOMER ANI phone number that correspond to calltype; e.g., cellular, government institution, etc.

AmexCPGoodsSoldData: Identifies merchandise such as gift cards, computers, and other electronics that can be resold for cash.

Code Example:

  Copy
TSYSRetail.Config("AmexCPGoodsSoldData=ProductCode=1000");

ProductCode

Four-byte goods product indicator code. Possible values:


1000	Gift Card

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).

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

BusinessApplicationId: Business Application Identifier (BAI). Visa only.

This applies to merchants that are enrolled in the Visa Consumer BillPay program.

Valid values are:


Value	Description
CB	Consumer Bill Payment

Note: When setting this configuration setting to CB you must also set the IsBillPayment to True.

Note: When enrolled in the Visa Consumer BillPay program, the MerchantName field must be in the 'CBPS Name * Biller' format and must match what is registered with Visa.

CanadaDomesticIndicator: Canada Domestic Indicator.

Sending a value of "Y" in this Mastercard only field indicates the merchant accepts Canada domestic Debit Mastercard. This value must be sent in every Credit Authorization Request for merchants that accept Canada region-issued Debit Mastercard cards.

If Canada Domestic Indicator was present in the original transaction it must be included in a reversal message.

CardholderId: Specifies the method used to verify the identity of the cardholder.

By default the class automatically computes the CardholderId based on several factors. Changing this config setting will override this automatic calculation. Clear this setting to "" (empty string) to restore automatic calculation. Please see the TSYSDetailRecord class's CardholderId property for more information.

CashOverAmount: The Cash Over amount requested.

This configuration setting may contain an optional cash over (cash back) amount when authorizing a Discover card purchase transaction. The value of TransactionAmount must reflect the cost of the goods or service purchased plus this CashOverAmount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Note: CashOverAmount is only available for Discover cards in the Retail and Grocery Store IndustryType.

Note: TSYS does not support transactions containing both CashOver and Gratuity/Tip amounts.

Note: CardPresent must be set to 'True' when requesting a CashOverAmount.

Note: AllowPartialAuths must be set to 'True' to use CashOverAmount.

Note: CashOverAmount's can be partially approved as well and thus you should use the ResponseCashOverAmount to verify the approved amount.

ChipConditionCode: The condition code of magnetic stripe read transactions of EMV (chip capable) cards.

This config is used to provide information about magnetic stripe read transactions using chip capable cards at chip capable POS devices.

Available values are:


Value	Description
0	Service code does not begin with a two or six or fill for subsequent positions that are present.
1	Service code begins with two or six; last CCPS read at the chip capable terminal was successful, or was not a chip transaction, or unknown.
2	Service code begins with two or six; last transaction at the chip capable terminal was unsuccessful chip read.

CITMITIndicator: CIT/MIT Indicator.

This 4-character field indicates whether the transaction was initiated by the Cardholder or the Merchant (Mastercard only).

Valid values are:

Customer Initiated Transaction (CIT)


Value	Description
C101	Credential on File
C102	Standing Order (variable amount, fixed frequency)
C103	Subscription (fixed amount and fixed frequency)
C104	Installment

Merchant Initiated Transaction (MIT) - Recurring or Installment


Value	Description
M101	Unscheduled Credential on File
M102	Standing Order (variable amount, fixed frequency)
M103	Subscription (fixed amount and fixed frequency)
M104	Installment

Merchant Initiated Transaction (MIT) - Industry Practice


Value	Description
M205	Partial Shipment
M206	Related/Delayed Charge
M207	No show Charge
M208	Resubmission

Note: If CIT/MIT Indicator was present in the original transaction it must be included in a reversal message.

CountryCode: Identifies the country where the merchant is located.

This field contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. The default is "840", indicating the United States.

CumulativeAmount: Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only).

This configuration setting is required for Visa and Discover Incremental transaction. When supporting incremental authorizations, you must manually keep track of the sum of all authorizations made for a single transaction (all based on the same transaction id). This total will be sent on G3v022 (additional amounts) with amount type 43.

CurrencyCode: Identifies the type of currency used by the merchant.

This field contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. The default is "840", indicating US Dollars. Other values may be used when processing multi-currency.

CurrentPendingResponseCount: Current number of pending response packets.

This is the current number of outstanding transactions that have not yet received a response. This is a read-only configuration setting.

CustomerAddress: Customer's billing address, used for Manually Keyed transactions.

CustomerZip: Zip code portion of the customer's billing address, used for Manually Keyed transactions.

When sending a manually-keyed transaction in a Retail, Restaurant, or Grocery environment it is possible to send AVS data (Customer's address and zip code) along with the card number. If sending the customer's address and zip code in a card-present retail transaction, you should also set the CardholderId configuration setting to "M".

CVV2Option: Verification code.

This field is used in assigning a value that assists in authenticating the physical presence of a Visa, MasterCard, Discover, PayPal or American Express credit cards.

Valid values are:


Code	Description
00	Verification Code is intentionally not provided - Only the normal Response Code should be returned
10	Verification Code is present - Only the normal Response Code should be returned
11	Verification Code is present - Response code and the Verification Code result code should be returned
20	Verification Code is present but illegible - Only the normal Response Code should be returned
90	Cardholder states that no Verification Code is present on the card - Only the normal Response Code should be returned

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.

DeviceCode: A 1-character value used to identify the device and type of the merchant submitting the settlement batch.

This configuration setting contains a 1-character value used to identify the device and type of the merchant submitting the settlement batch. The table below provides a summary of currently defined values. The default value for this setting is "Q".


0	Unknown or unsure.
B	Automated Teller Machine (ATM).
C	Personal Computer (PC)
D	Dial terminal
E	Electronic Cash Register (ECR)
G	Mobile Payment Acceptance.
H	TSYS Hosted Payment.
I	In-store processor
J	Multi Payment Acceptance.
M	Mainframe
P	POS-Port
Q	Third-party developer
R	POS-Port
S	POS Partner
T	Counter Payment Acceptance.
W	Web Payment Acceptance.
X	EMV Mode Contact and/or Contactless terminal (Must be used on all EMV mode chip card transactions).
Z	Suppress PS2000/Merit fields

DisconnectInterleaved: To explicitly terminate the connection.

This configuration setting is read only and can be used to explicitly close the interleaved connection. This is usually used when all response packets are received.

DoEvents: Processes events from the internal message queue.

This configuration setting is read only and can be used to process any available events. If no events are available, it waits for a preset period of time, and then returns.

DomainServer: Remote domain server indicator.

This field is used to indicate the remote domain server indicator for cardholder PayPass device types. Valid values are:


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

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.

EMVOnlineKSN: Clear-text Key Sequence Number for EMV Online PIN transactions.

This field is used along with EMVOnlinePIN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. The maximum length is 16 characters.

EMVOnlinePIN: DUKPT DES encrypted PIN block for EMV Online PIN transactions.

This field is used along with EMVOnlineKSN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. The maximum length is 16 characters.

GatewayID: A unique value to identify a Gateway or Aggregator.

This 10 character field provides a unique value to identify a Gateway or Aggregator. This number is provided by TSYS Acquiring Solutions during the certification process.

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.

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.

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):


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

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

HeartlandKeyBlock: Specifies the key block used to encrypt the data.

This field allows you to specify the key block that was used to encrypt the data specified by HeartlandEncryptionMode. This value will be obtained from an E3 magnetic stripe reader and is used by Heartland to decrypt the encrypted data.

IncrementalApprovalCode: Transaction Approval Code associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the ApprovalCode from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalRetrievalNumber: Transaction Retrieval Number associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the RetrievalNumber from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalTransDate: Transaction Date associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the TransmissionDate from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalTransId: Transaction Id associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the TransactionId from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalTransTime: Transaction Time associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the TransactionTime from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

InterleavedMode: Determines whether to use Interleaved Transaction Mode for authorization requests.

Interleaved Mode is intended for high volume transaction environments. When using this communication mode, transaction data is transmitted and received simultaneously without blocking. The advantage of an Interleaved Session is that the connection can stay up and is stateless once connected. Up to 10 simultaneous requests can be sent at a time. By default the value for this configuration setting is False. For instance:

  Copy
        //Interleaved Transaction Mode 
        TSYSECommerce1.Config("InterleavedMode=True");

        //Maximum number of pending response packets.
        TSYSECommerce1.Config("MaxPendingResponseCount=10");

        TSYSECommerce1.OnResponse += (sender, args) =>
        {
            Console.WriteLine("Response received for {0}, {1}, {2}, {3}", args.TransactionId, args.ResponseCode, args.ResponseText, args.ResponseApprovalCode);
        };

        TSYSECommerce1.Authorize();

        //Explicitly Disconnect
        TSYSECommerce1.Config("DisconnectInterleaved");

InterleavedTimeout: Timeout value to wait for a response from TSYS.

When InterleavedMode is set to True the class will return immediately when Authorize is called. This setting specifies the timeout (in seconds) for which the component will wait for a response. If no response is received within InterleavedTimeout seconds the Error event will fire and the connection will be closed.

The default value is 60 (seconds).

IsBalanceInquiry: Indicates that the transaction is a Balance Inquiry transaction.

To send a Balance Inquiry transaction you must set this field to 'True' and call the AuthenticateCard method. The default value for this field is 'False'.

The following code demonstrates a Balance Inquiry transaction:

  Copy
  TSYSRetail1.TransactionAmount = "";
  TSYSRetail1.Config("IsBalanceInquiry=True");
  TSYSRetail1.AuthenticateCard();

The Ledger Balance and/or Available Balance if returned in the Response message can be accessed via those two read only configuration settings: ResponseLedgerBalance, ResponseAvailableBalance.

Note: Balance Inquiry transaction is Card Present only - it cannot be sent as Card Not Present.

IsBillPayment: Indicates that the transaction is a bill payment transaction.

This field, when set to 'True', indicates that the transaction is a Bill Payment transaction and will be processed as such. When set to 'False' (default value) the transaction will be processed normally.

IsEstimatedAmount: Specifies whether the amount is an estimate. Visa transactions only.

Set this to True when the amount sent in the initial transaction is an estimate. Default value is 'False'.

IsMerchantInitiatedTransaction: Set this to process a Merchant Initiated transaction.

To process a Merchant Initiated Transaction you need to set this IsMerchantInitiatedTransaction flag to True. Default value is False.

ISOIdentifier: ISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover.

This 11-digit value is assigned to the Service Provider designated as an ISO (Independent Sales Organization) during registration with the card brand and must be included on all MasterCard or Discover transactions where the merchant has a relationship with an ISO.

IsPurchaseReturnAuthorization: Set this to process a Purchase Return Authorization transaction.

To process an online Purchase Return transaction you need to set this IsPurchaseReturnAuthorization flag to True. Default value is 'False'.

Note: To Reverse a Purchase Return Authorization you should use the TSYSReversal class and set the ReversalType to rtCreditAuthorization (5) before calling the Reverse method.

LaneId: Identifies a terminal at the card acceptor location of acquiring institutions or merchant POS systems.

The Terminal/Lane ID may be printed on all POS transactions where the terminal is capable of generating customer receipts. This is an eight digit numeric field and it can be sent for any card brand.

LocationDetailAddress: Merchant's street address.

This field is used to identify the merchant's street address where the transaction took place. The maximum length is 38 characters (upper-case). For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 20 characters and if necessary this value should be truncated rather than abbreviated.

LocationDetailCity: Name of the city.

This field is used to identify the name of the city where the transaction took place. The maximum length is 21 characters (upper-case). For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 13 characters.

LocationDetailCountry: Country code.

This field is used to identify the country code of the location where the transaction took place. For example, the country code for USA is "840." The maximum length is 3 characters.

LocationDetailEmail: Merchant's e-mail adress.

This field is used for American Express transactions that are submitted via an Aggregator/Payment Service Provider. It is used to identify the Aggregator's e-mail address. The maximum length is 20 characters and if necessary this value should be truncated rather than abbreviated.

LocationDetailName: Merchant name.

This field is used to identify the merchant name that appears on the storefront and/or customer receipts and statements. The maximum length is 38 characters (upper-case). For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 30 characters and if necessary this value should be truncated rather than abbreviated.

LocationDetailPhone: Merchant's phone number.

This field is used for American Express transactions that are submitted via an Aggregator/Payment Service Provider. It is used to identify the Aggregator's phone number. This value should be 10 characters in length and it must include the area code.

LocationDetailPostal: Postal code.

This field is used to identify the postal / zip code of the location where the transaction took place. The maximum length is 15 characters. For American Express transactions that are submitted via an Aggregator/Payment Service Provider the maximum length is 10 characters.

LocationDetailRegion: Region code that corresponds to the state, province, or other country subdivision.

This field is used to identify the region code that corresponds to the state, province, or other country subdivision of the merchant location where the transaction took place. The maximum length is 3 characters.

MastercardWalletId: Mastercard Wallet Identifier used to identify the Wallet Provider.

This 3-character value provides information about transactions initiated through the Masterpass Online platform or through the Mastercard Digital Enablement Service (MDES) and identifies the Wallet Provider. For MDES, Mastercard inserts the Wallet Identifier that is in the system, when available. For Masterpass, Mastercard passes the Wallet Identifier as sent in from the Point of Sale.

The following values apply to both Masterpass and MDES transactions:


Value	Description
101	Masterpass by Mastercard

The following values only apply to MDES transactions:


Value	Description
103	Apple Pay
216	Google Pay
217	Samsung Pay
327	Merchant tokenization program

Note: This value will be sent as part of G3v064 group in authorization request and as part of ODG41 group (Tag: "WID") in settlement.

MaxPendingResponseCount: Maximum number of pending response packets.

This is the maximum number of outstanding transactions that have not yet received a response. This should not exceed the maximum number of 10 interleaved transactions that can be sent at the same time. If an authorization is attempted that would exceed the maximum number of pending response an error occurs.

The default value is 10.

MerchantLanguage: Designates the language that response messages will be returned in.

This field contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message.

MerchantSellerID: Merchant's Seller ID.

This field is used for American Express transactions that are submitted via an Aggregator/Payment Service Provider. It contains a maximum 20-byte numeric code that uniquely identifies an American Express Payment Service Provider's (Aggregator's) seller or vendor code.

MessageReasonCode: Code used to identify MIT or Deferred Authorizations for Visa.

This field is used to identify Merchant Initiated or Deferred Authorizations for Visa.

Merchant Initiated Transactions A Merchant Initiated Transaction (MIT) is any transaction that relates to the previous consumer-initiated transaction but is conducted without the consumer being present and without any cardholder validation performed. Valid values are:


Code	Description
3900	Incremental Authorization (this is a continuation of the consumer purchase)
3901	Resubmission (valid when the original authorization was declined for insufficient funds)
3902	Delayed Charges (account charge associated with an agreement between a cardholder and a merchant for services rendered)
3903	Reauthorization (purchase made after the original purchase such as: split shipment, estimated amount etc.)
3904	No Show (when the customer did not meet the terms of the agreement and the merchant is able to charge for it)

Deferred Authorizations If the merchant's Point-of-Interaction (POI) authorization system is offline and cannot process transactions, the merchant often completes the transaction with the cardholder and will then defer the authorization until their POI system is back online. Valid value is:


Code	Description
5206	Deferred Authorization

MITTransactionId: Transaction Id associated with the original authorization of a Merchant Initiated Transaction.

This configuration setting is required when sending an Merchant Initiated Transaction, when the IsMerchantInitiatedTransaction is set to 'True'. It should be set with the TransactionId from the original (first) authorization. This configuration setting is required when sending MIT Recurring, MIT Installment, MIT Standing Instruction or MIT Industry Practice transactions. To send an MIT Standing Instruction you need to set the POSEnvironmentIndicator to specify the type of merchant initiated transaction. To send an MIT Industry Practice you need to set the MessageReasonCode to specify the reason for this merchant initiated transaction.

Note: For Merchant Initiated Transactions you need to set the POSDataCode.CardInputMode to '7'.

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 using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO
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 (such as CDMA)
08	Removable secure element not controlled by the MNO, for example, memory 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 (such as memory card personalized for use with a tablet or e-book)
13	Tablet or E-Book with fixed (nonremovable) secure element not controlled by the MNO
14	Mobile Phone or Smartphone with a payment application running in a host processor
15	Tablet or E-Book with a payment application running in a host processor
16	Mobile Phone or Smartphone with a payment application running in the TEE of a host processor
17	Tablet or E-Book with a payment application running in the TEE of a host processor
18	Watch with a payment application running in the TEE of a host processor
19	Watch with a payment application running in a host processor
20	Card
21	Phone (i.e. Mobile phone)
22	Tablet/e-reader (i.e. Tablet computer or e-reader)
23	Watch/Wristband (i.e. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band)
24	Sticker
25	PC (i.e. PC or laptop)
26	Device Peripheral (i.e. Mobile phone case or sleeve)
27	Tag (i.e. Key fob or mobile tag)
28	Jewelry (i.e. Ring, bracelet, necklace, and cuff links)
29	Fashion Accessory (i.e. Handbag, bag charm, and glasses)
30	Garment (i.e. Dress)
31	Domestic Appliance (i.e. Refrigerator, washing machine)
32	Vehicle (i.e. Vehicle, including vehicle attached devices)
33	Media/Gaming Device (i.e. Media or gaming device, including a set top box, media player, and television)
34-99	These values reserved for future form factors. Any value in this range may occur within form factors and transaction data without prior notice.

MPGID: Merchant Payment Gateway ID.

The Merchant Payment Gateway Identifier (MPGID) is a unique value that is generated and provisioned by Mastercard. Payment gateways must register directly with Mastercard to obtain a unique value, and include it on the incoming authorization message. Maximum length for this field is 11 digits.

MSDI: Market Specific Data Indicator.

The Market Specific Data Identifier (MSDI) is used to indicate which industry data is being submitted. Generally, the component will automatically determine the correct value and you do not need to set this. However, in certain cases you may need to manually set this config.

OriginalAmount: The Original Amount related to a previous Consumer Initiated Transaction (Discover only).

This configuration setting is required for Discover Merchant Initiated Transactions (MIT) with TransactionStatus: (P) Partial Shipment, (R) Recurring Payment, or (A) Re-authorize for Full Amount. It should be used in conjunction with OriginalAmountAccountType. The class will send the OriginalAmount on group G3v022 with amount type 57 (Original Amount).

Note: When supporting MIT transactions for Discover cards, you must keep track of the Original Amount from the initial CIT transaction.

OriginalAmountAccountType: The Account Type of the Original Amount (Discover only).

This 2-character value configuration setting indicates the account type such as "30" for Credit Card, "40" for Universal etc. (see TSYS Specs G3v022 for complete list). It should be used in conjunction with OriginalAmount.

PFAcquirerInternalReferenceNumber: Acquirer Internal Reference Number (AIRN) (Discover only).

This unique digit internal identification code is assigned by the Acquirer to it's merchant. Discover assigns this 20-character field during registration via the Discover Network.

PFForeignRetailerIndicator: The Payment Facilitator Foreign Retailer Indicator (Visa only).

This 3-character field is used by marketplaces to uniquely identify domestic transactions in which the retailer is in a different country than the marketplace. Visa classifies an entity as a marketplace if it handles payments on behalf of retailers through an online marketplace that brings together multiple buyers and retailers. This field must be sent when the retailer is foreign.

Valid values are:


Code	Description
(Space) (default)	Space indicates the retailer is not foreign.
F	This value indicates the retailer is located in a different country than the marketplace.

Note: This field will be automatically left-justified, space-filled to 3 characters.

PFIdentifier: The Payment Facilitator/Marketplace Identifier assigned by Visa, MasterCard, or Discover.

This 11-digit value is assigned to the Service Provider during registration with the card brand and must be included on all Visa, MasterCard, or Discover transactions where the merchant has a relationship with a Payment Facilitator/Service Provider.

Note: For Visa Marketplaces, the Marketplace ID must be included in this field.

PFNameSubMerchantName: The Payment Facilitator Name*Sub-Merchant name.

This 25-character field is a subfield of Payment Facilitator and must be included on all transactions where the merchant has a relationship with a Payment Facilitator. It has two usages:

Usage 1 - Payment Facilitator Name*Sub-Merchant Name

This usage is valid for Visa, Mastercard, and Discover.

For Payment Facilitators, the field contains two parts in a concatenation of two fields separated by an asterisk (*). For Visa, Mastercard, and Discover the name submitted should match what the PayFac registered with each brand and should follow the requirements defined by each brand.

Usage 2 - Marketplace Name

For Visa Marketplaces, the field should contain the name of the Marketplace.

PFSubMerchantCity: The Payment Facilitator Sub-Merchant City.

This 13-character field is a subfield of Payment Facilitator.

For Visa and Mastercard transactions, enter the city of the sub-merchant location (not the Payment Facilitator location).

For Discover transactions, enter the location where the transaction took place; this may or may not be the sub-merchant location.

For Direct Marketing merchants and preferred customer/passenger transport and card not present transactions, this field must contain a phone number for merchant customer service in format XXX-XXXXXXX. The dash is required. This field can also be used for e-mail or a URL.

PFSubMerchantCountry: The Payment Facilitator Sub-Merchant Country Code.

This 3-digit field indicates the country of the Sub-Merchant location (not the Payment Facilitator location) using ISO-specified numeric codes. It is used for Visa, Mastercard, and Discover transactions and must be included on all transactions where the merchant has a relationship with a Payment Facilitator.

PFSubMerchantIdentifier: The Payment Facilitator Sub-Merchant Identifier.

This 15-character field, assigned by the Payment Facilitator or the Acquirer, must be provided on all Visa, Mastercard, or Discover transactions where the merchant has a relationship with a Payment Facilitator.

PFSubMerchantPostalCode: The Payment Facilitator Sub-Merchant Postal Code.

This 9-character field indicates the postal code of the Sub-Merchant location (not the Payment Facilitator location). This field must be included on all transactions where the merchant has a relationship with a Payment Facilitator. It is used for Visa, Mastercard, and Discover transactions.

PFSubMerchantState: The Payment Facilitator Sub-Merchant State/Province Code.

This 2-character field indicates the state or province code of the Sub-Merchant location (not the Payment Facilitator location). If the Sub-Merchant is non-U.S. and non-Canadian, this field should be '00'. This field must be included on all Visa, Mastercard, and Discover transactions where the merchant has a relationship with a Payment Facilitator.

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.

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:

  Copy
TSYSRetail.Config("POSDataCode=CardholderAuthCap=1;CardInputMode=2;CardInputCap=2");

CardInputCap (Terminal card data input capability)


0 (default)	Unspecified, data not available
1	Manual; no terminal; Voice auth/ARU
2	Magnetic stripe reader capability
3	Bar code/ Payment code
4	Optical character reader (OCR) capability, [MC, AX]
5	Integrated circuit card (ICC) capability and magnetic stripe reader
6	Key entry only capability; Mastercard recurring and installment transactions
A	PAN auto-entry via contactless magnetic stripe
B	Magnetic stripe reader and key entry capability
C	Magnetic stripe reader, ICC, and key entry capability
D	Magnetic stripe reader and ICC capability
E	ICC entry capability
H	ICC Reader and Contactless Capability; Magnetic stripe & manual entry implied
M	PAN auto-entry via contactless chip
V	Other capability, [MC]
X	Reserved for private use

CardholderAuthCap (Terminal cardholder authentication capability)


0	No electronic authentication capability
1	PIN entry capability
2	Electronic signature analysis capability
3	mPOS software-based PIN entry capability
5	Electronic authentication capability is inoperative
6	Other
9 (default)	Unspecified, data not available

CardCaptureCap (Terminal 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; Voice auth/ARU; Mastercard recurring/installment transactions
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
M	Off card acceptor premises; merchant mobile POS environment, including mPOS
P	On card acceptor premises; merchant mobile POS environment, including mPOS
Q	Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA
R	On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA
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	Cardholder not present; recurrent billing such as a loan or installment payment
R	Recurring purchase transaction (original transaction was token-based with valid cryptogram)
T	PayButton (Discover only)

CardPresent (Card present data)


0	Card not present
1	Card present
W	Transponder, [AX]
X	Contactless Chip Transactions, including AMEX Expresspay
Z	Digital Wallet [AX]

CardInputMode (Card data input mode)


0 (default)	Unspecified, data not available
1	Manual input; no terminal; Voice auth/ARU
2	Magnetic stripe reader input
3	Bar code/Payment code
6	Key entered input
7	Payment Credential stored on file. NOTE: This value is required for all Mastercard recurring transactions.
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 (EMV Mode)
N	Track data read and sent unaltered, chip capable terminal, chip data could not be read
P	Empty candidate list fallback
R	PAN Entry via electronic commerce, including remote chip
S	Electronic commerce, no security, channel encrypted, or SET without cardholder certificate
V	Manually entered with keyed CID, [AX, JCB Canada]
W	Swiped transaction with keyed CID, [AX, JCB Canada]
X	Reserved for private use
Y	Reserved for private use
Z	Contactless Interface Change Identifies when a Chip Card Transaction with a dualinterface card switches from a contactless to a contact chip card transaction [Discover]

NOTE: AMEX defines ApplePay with value C - Online Chip

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	ICC - 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	ICC
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

Note: Setting this configuration setting in TSYSDetailRecord class will not update the POSDataCode tag in the detail aggregate of the original transaction.

POSEnvironmentIndicator: Provides additional information about the transaction for Visa.

This Visa only configuration setting is used to provide additional information about the transaction. This value should be set in the following scenarios with the respective values:


Value	Description
C	Card On File
I	Installment Payment
R	Recurring Payment

Note: If the merchant stores payment credential for the first time, the value in POSDataCode.CardInputMode should reflect the actual entry mode for the transaction (i.e. manual input, key entered).

If the merchant initiates a transaction using a stored payment credential, the value in POSDataCode.CardInputMode should be '7' for Credential on File transactions.

Processor: Specifies the Processor you are connecting to.

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


0	TSYS (default)
1	Heartland

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.

RequestToken: Indicates whether to request a token for the specified card data sent in an Authorize request.

When set to 'True' prior to an Authorize request, a token will be requested for the specified Card data. Provided the authorization and token generation was successful, a token will be returned in the response and can be retrieved via Token. Additionally the status of the token will be returned via ResponseTokenStatus. The returned token can then be used to process future transactions without the use of Card data with the exception of the expiration details. The default value is 'False'.

NOTE: When using this request, verification and authorization of the card will be performed.

ResponseAvailableBalance: Response Available Balance.

This field contains Response Available Balance returned in the authorization response text message (part of group G3v022 Additional Amounts - amount type 02).

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

ResponseCashOverAmount: The Cash Over amount approved.

This configuration setting contains the cash over (cash back) amount of an authorized Discover card purchase transaction and will only be populated if a cash over amount was received in the authorization response.

Note: Cash Over amounts can be partially approved and thus ResponseCashOverAmount may not be the same as the original CashOverAmount value requested.

ResponseEMVData: The EMV Data returned in an authorization response.

This configuration setting contains the EMV Data in TLV (tag-length-value) format. This field will only be populated if an EMV transaction was performed and EMV Data was received in the authorization response.

ResponseLedgerBalance: Response Ledger Balance.

This field contains Response Ledger Balance returned in the authorization response text message (part of group G3v022 Additional Amounts - amount type 01).

ResponseMerchantAdviceCode: The Merchant Advice Code returned by Mastercard MIP for declined CNP transactions.

Possible returned values are:


Value	Description
01	New account information
02	Try again later
03	Do not try again for recurring payment transaction
04	Token requirements not fulfilled for this token type
21	Recurring payment cancellation
22	Merchant does not qualify for product code

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 StoreNumber. 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 StoreNumber 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 TerminalNumber. 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 TerminalNumber, the transaction should not be stored for batch settlement. This field is read-only.

ResponseTokenStatus: The status of retrieval of the token.

This field will be populated after a token is requested via RetrieveToken or RequestToken. The applicable values are:


Value	Description
0	Token retrieval was successful and is included.
1	Terminal not configured to receive a token.
2	Terminal was not authenticated.
3	System failure.

ResponseTransactionIntegrityClass: A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class.

This read-only configuration setting contains a 2-character value when returned in the response of MasterCard Credit transactions. This value encompasses the fundamental safety and security of credit transactions, including the assessment of both the validity of the card and the cardholder.

RetailDepartmentName: Department name.

This field is used to identify the department name within the location where the transaction took place. The maximum length is 40 characters.

RetrieveToken: Sends a Token Only request.

This is an action config which when called will send a token only request to the TSYS Host. Provided the request was successful, a token will be returned for the specified Card. The token can be retrieved via Token and the status of the token will be returned via ResponseTokenStatus. For this request, no card verification or authorization will be performed.

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).

SendCommCardInd: Indicates whether to send Commercial Card Request Indicator.

If set to True (default), the CommercialCardType field will indicate whether the credit card submitted for authorization is a Business, Corporate, or Purchasing Card (this is the default function). If False, the contents of the CommercialCardType property must be ignored.

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.

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.tsysacquiring.net" 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 BankIds and Numbers that will always run in test mode regardless of whether you are using the live server. See the included demos for examples.

ServiceLocationCity: Name of the city where the cardholder received the services.

This field contains the name of the city where the cardholder received the services, if it is different from the location identified by the acceptor city name. This value will be sent as part of group G3v089 in authorization and group ODG41 (Tag: "SLD") in settlement.

The maximum length for this field is 13 characters.

ServiceLocationCoordinates: Geographic Coordinates of the location where the cardholder received services.

This field contains the geographic coordinates of the location where the cardholder received services. Providing the geographic coordinates at the transaction level for merchants that change location (i.e. food truck) may help the cardholder recognize the transaction on their statement. This value will be sent as part of group G3v089 in authorization and group ODG41 (Tag: "SLD") in settlement.

Geographic Coordinate Format Guidelines:

The geographic coordinates, when present, must contain valid latitude and longitude values, comma-separated, represented in decimal degrees to five decimal places in positions 001 through 020 with these format standards:

Length is a range of 15 - 20
Contains up to two '-'
Contains precisely two '.'
Contains precisely one ','
At least one numeric position is before the first '.'
Five numeric positions are found between the first '.' and ','
At least one numeric position is found between ',' and the second '.'
Five numeric positions are found after the second '.'
Latitude is greater than or equal to -90.00000 and less than or equal to 90.00000
Longitude is greater than or equal to -180.00000 and less than or equal to 180.00000
No space character follows the comma separator
No alpha characters allowed

Example: Location: Anchorage, AK Latitude & Longitude: 61.21630,-149.89500

ServiceLocationCountryCode: Country code where the cardholder received the services.

This field contains the code of the country where the cardholder received the services, if it is different from the location identified by the acceptor country code. This value will be sent as part of group G3v089 in authorization and group ODG41 (Tag: "SLD") in settlement.

The maximum length for this field is 3 characters.

ServiceLocationCountrySubdivision: Region code that corresponds to the state, province, or other country subdivision.

This field contains the code of the country subdivision where the cardholder received the services, if it is different from the location identified by the acceptor country subdivision code. This value will be sent as part of group G3v089 in authorization and group ODG41 (Tag: "SLD") in settlement.

The maximum length for this field is 3 characters.

ServiceLocationPostalCode: Postal code where the cardholder received the services.

This field contains the postal code of the country where the cardholder received the services, if it is different. This value will be sent as part of group G3v089 in authorization and group ODG41 (Tag: "SLD") in settlement.

The maximum length for this field is 10 characters.

SpecialConditionIndicator: Describes selected special conditions at the POS.

This field describes selected special conditions at the point of sale.

Valid values are:


Value	Description
7	Purchase of Cryptocurrency. The transaction is related to purchase of cryptocurrency.
8	Quasi-Cash. The transaction is for a product or item that is representative of actual cash such as money orders, traveler's checks, foreign currency, lottery tickets, or casino gaming chips.
9	Existing Debt Indicator. The transaction includes payment on an existing debt.

SurchargeAmount: The transaction fee amount charged to the customer to account for acquirer-assessed surcharge.

This configuration setting is for informational purposes only and any surcharge amounts charged to the customer should be included in the TransactionAmount.

The format of this field is 'annnnnnnn' where 'a' is either 'D' for debit or 'C' for credit. 'nnnnnnnn' is the numeric fee amount with the decimal implied. For example: 'D00000150' is a $1.50 transaction fee amount debited to the cardholder's account.

Note: If an amount is only specified, the component will generate the format above by prepending a 'D' and the necessary number of 0's.

TLID: Transaction Link Identifier.

The Transaction Link Identifier (TLID) is used to track the life cycle of activity occurring after the original transaction and other related transactions. The TLID will be returned by Mastercard in the authorization response message. The returned value will also be present in the aggregate returned from the GetDetailAggregate method and for all subsequent transactions that utilize the aggregate (such as reversals, incrementals, settlement) the value will be automatically included in the request. When not utilizing the aggregate, you may explicitly set this config with the TLID value that was saved when the original transaction was performed.

Token: The token received from the TSYS host when a token request is sent.

This field will contain the token received from TSYS from either a RetrieveToken or RequestToken request. This field is also used to specify a token value, used in place of Card data, to be sent in an Authorize request. The token is formatted as a card number, with the last 4 digits preserved. Other characters in the number will be letters rather than numbers. Tokens are 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.

TransactionStatus: A 1-character value used to indicate the purpose or status of the request.

Use this 1-character configuration setting to indicate the purpose or status of the request.

The tables below provide the valid values for each card brand.

Valid value for Visa is:


I	One or more incremental authorizations were performed.

Valid values for Mastercard are:


Value	Description
0	Normal request (original presentment)
1	Deferred Authorizations
2	SecureCode Phone Order
3	ATM Installment Inquiry
4	Preauthorized request
5	Time Based Payment Authorization Request-Brazil domestic transactions
6	ATC Update
8	Account Status Inquiry Service (ASI)
9	Tokenization Request/Notification

Valid values for Discover are:


Value	Description
0	Normal request (original presentment)
4	Preauthorized request
A	Re-authorize for Full Amount
D	Delayed Card Sale
E	Resubmission of Card Sale
G	Transit Aggregated Transaction
I	Incremental Authorization
N	No-Show Charge
P	Partial Shipment
R	Recurring Payment
S	Merchant Installment Payment
T	Third Party Installment Payment
U	Unscheduled Payment
V	Issuer Installment Payment

Note: For Purchase Return Authorization Requests: Value must be 0 (Mastercard and Discover).

TransactionTypeIdentifier: Transaction Type Identifier (or Payment Transaction Identifier).

This Mastercard field indicates the type of additional transaction purpose.

Valid values are:


Value	Description
C03	rePower Load Value
C04	Gaming Re-Pay
C06	Payment of Credit Card Balance with Cash or Check
F07	General Person-to-Person Transfer
F08	Person-to-Person Transfer to Card Account
F52	General Transfer to Own Account
F53	Agent Cash Out
F54	Payment of Own Credit Card Bill
F55	Business Disbursement
F61	Transfer to Own Staged Digital Wallet Account
F64	Transfer to Own Debit or Prepaid Card Account
F65	General Business-to-Business Transfer
P10	Purchase Repayment
P70	Cryptocurrency
P71	High Risk Securities

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 MagneticStripe or Number fields.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount: The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.example.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

SSLCACertFilePaths: The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following:

  Copy
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");

Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

  Copy
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.