TSYSTerminalMgr Class

Properties Methods Events Config Settings Errors

The TSYSTerminalMgr class is used to authenticate and deactivate POS devices on the TSYS Terminal Capture platform.

Syntax

TSYSTerminalMgr

Remarks

The TSYSTerminalMgr class makes authenticating and deactivating terminals simple. Terminal authentication can help reduce fraud risk and is recommended. Before authenticationg a device an AuthenticationCode must be obtained from TSYS. Provide the AuthenticationCode and other merchant information when calling AuthenticateDevice to obtain a GenKey.

Once the GenKey is obtained include this in all transactions from the terminal. When processing transactions using other components the GenKey may be specified via the Config method. For example:

  Copy
TSYSRetail1.Config("GenKey=MY_GEN_KEY");

To deactivate a terminal set GenKey and call DeactivateDevice.

Authenticating a Terminal

AuthenticateDevice authenticates a POS device with TSYS. After a device is authenticated GenKey will hold a unique value that should be included in all future transaction requests from the terminal. Before calling this method an AuthenticationCode must be obtained from TSYS.

The following Merchant fields are applicable when calling this method:

BankId
CategoryCode
CountryCode
CurrencyCode
Language
Number
ServicePhone
StoreNumber
TerminalNumber
TimeZone
Zip

The following additional properties are also applicable:

AuthenticationCode
TransactionNumber
DeviceCode
IndustryType

After calling this method check Code to determine if the authentication succeeded. If the authentication succeeded Code will be "A1" and GenKey will be populated. If authentication failed Code will be "A2".

In addition to GenKey the following Response fields are populated:

Code
TransactionDate
TransactionNumber
TransactionTime
AuthSource
Text

AuthenticateDevice Example:

  Copy
TSYSTerminalMgr1.Merchant.BankId = "999999";
TSYSTerminalMgr1.Merchant.CategoryCode = "9999";
TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT";
TSYSTerminalMgr1.Merchant.Number = "888000002447";
TSYSTerminalMgr1.Merchant.StoreNumber = "5999";
TSYSTerminalMgr1.Merchant.TerminalNumber = "1234";
TSYSTerminalMgr1.Merchant.Zip = "27516";
TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807";
TSYSTerminalMgr1.TransactionNumber = 1234;
TSYSTerminalMgr1.AuthenticationCode = "N123456789";
TSYSTerminalMgr1.AuthenticateDevice();

string genkey = "";
if (TSYSTerminalMgr1.Response.Code == "A1") //approved
  genkey = TSYSTerminalMgr1.GenKey;

Processing Transactions

When processing transactions with other components in the toolkit smply set the "GenKey" configuration setting. For instance:

  Copy
TSYSRetail1.TransactionAmount = "1200";
TSYSRetail1.TransactionNumber = 2345;
TSYSRetail1.IndustryType = TsysretailIndustryTypes.sitRetail;
TSYSRetail1.Card.EntryDataSource = EntryDataSources.edsTrack1;
TSYSRetail1.Card.MagneticStripe = "B4444333322221111^DOE/JOHN E         ^091210100000033301000000008000000";

TSYSRetail1.Config("GenKey=" + genkey);

TSYSRetail1.Authorize();

Deactivating a Terminal

DeactivateDevice is used to deactivate a previously activated terminal identified by GenKey.

The following Merchant fields are applicable when calling this method:

BankId
CategoryCode
CountryCode
CurrencyCode
Language
Number
ServicePhone
StoreNumber
TerminalNumber
TimeZone
Zip

The following additional properties are also applicable:

GenKey
TransactionNumber
DeviceCode
IndustryType

After calling this method check Code and confirm it is "A3" to indicate the deactivation succeeded. The following Response fields are populated:

Code
TransactionDate
TransactionNumber
TransactionTime
AuthSource
Text

DeactivateDevice Example:

  Copy
TSYSTerminalMgr1.Merchant.BankId = "999999";
TSYSTerminalMgr1.Merchant.CategoryCode = "9999";
TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT";
TSYSTerminalMgr1.Merchant.Number = "888000002447";
TSYSTerminalMgr1.Merchant.StoreNumber = "5999";
TSYSTerminalMgr1.Merchant.TerminalNumber = "1234";
TSYSTerminalMgr1.Merchant.Zip = "27516";
TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807";
TSYSTerminalMgr1.TransactionNumber = 1234;
TSYSTerminalMgr1.GenKey = "MY_GEN_KEY";
TSYSTerminalMgr1.DeactivateDevice();

if (TSYSTerminalMgr1.Response.Code == "A3") //deactivated
  //...

Property List

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


AuthenticationCode	An alphanumeric code used during the POS device authentication process.
GenKey	A random alphanumeric value returned by TSYS.
IndustryType	Code which indicates the industry the merchant is engaged in.
Merchant	Contains the merchant's setup information.
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.
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.


AuthenticateDevice	Authenticates a POS terminal.
Config	Sets or retrieves a configuration setting.
DeactivateDevice	Deactivates a POS terminal.
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.
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.


Port	The port to which transactions are posted.
Server	The server to which transactions are posted.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
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.

AuthenticationCode Property (TSYSTerminalMgr Class)

An alphanumeric code used during the POS device authentication process.

Syntax

ANSI (Cross Platform)
char* GetAuthenticationCode();
int SetAuthenticationCode(const char* lpszAuthenticationCode);

Unicode (Windows)
LPWSTR GetAuthenticationCode();
INT SetAuthenticationCode(LPCWSTR lpszAuthenticationCode);

char* dpaymentssdk_tsysterminalmgr_getauthenticationcode(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setauthenticationcode(void* lpObj, const char* lpszAuthenticationCode);

QString GetAuthenticationCode();
int SetAuthenticationCode(QString qsAuthenticationCode);

Default Value

Remarks

An alphanumeric code, provided to the POS user by TSYS, which is used during the POS device authentication process. Note that this property is required when calling AuthenticateDevice.

Data Type

String

GenKey Property (TSYSTerminalMgr Class)

A random alphanumeric value returned by TSYS.

Syntax

ANSI (Cross Platform)
char* GetGenKey();
int SetGenKey(const char* lpszGenKey);

Unicode (Windows)
LPWSTR GetGenKey();
INT SetGenKey(LPCWSTR lpszGenKey);

char* dpaymentssdk_tsysterminalmgr_getgenkey(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setgenkey(void* lpObj, const char* lpszGenKey);

QString GetGenKey();
int SetGenKey(QString qsGenKey);

Default Value

Remarks

This value holds the GenKey value for the terminal. It is populated after calling AuthenticateDevice. It is required before calling DeactivateDevice.

This value should be stored on the POS device and used in all transaction requests.

Data Type

String

IndustryType Property (TSYSTerminalMgr 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_tsysterminalmgr_getindustrytype(void* lpObj);
int dpaymentssdk_tsysterminalmgr_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 (TSYSTerminalMgr Class)

Contains the merchant's setup information.

Syntax

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

char* dpaymentssdk_tsysterminalmgr_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);

char* dpaymentssdk_tsysterminalmgr_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);

char* dpaymentssdk_tsysterminalmgr_getmerchantcity(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcity(void* lpObj, const char* lpszMerchantCity);

char* dpaymentssdk_tsysterminalmgr_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);

char* dpaymentssdk_tsysterminalmgr_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);

char* dpaymentssdk_tsysterminalmgr_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);

char* dpaymentssdk_tsysterminalmgr_getmerchantname(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantname(void* lpObj, const char* lpszMerchantName);

char* dpaymentssdk_tsysterminalmgr_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

char* dpaymentssdk_tsysterminalmgr_getmerchantphone(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);

char* dpaymentssdk_tsysterminalmgr_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);

char* dpaymentssdk_tsysterminalmgr_getmerchantstate(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantstate(void* lpObj, const char* lpszMerchantState);

char* dpaymentssdk_tsysterminalmgr_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);

char* dpaymentssdk_tsysterminalmgr_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);

char* dpaymentssdk_tsysterminalmgr_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

char* dpaymentssdk_tsysterminalmgr_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);

char* dpaymentssdk_tsysterminalmgr_getmerchantzip(void* lpObj);
int dpaymentssdk_tsysterminalmgr_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

Response Property (TSYSTerminalMgr Class)

Contains the response to an authorization request.

Syntax

DPaymentsSDKTSYSResponse* GetResponse();

char* dpaymentssdk_tsysterminalmgr_getresponseapprovalcode(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponseauthorizedamount(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponseauthsource(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponseavsresult(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsecardlevel(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsecode(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getresponsecommercialcardtype(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsecvvresult(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponseretrievalnumber(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsereturnedaci(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsetext(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsetransactiondate(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsetransactionid(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsetransactionnumber(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getresponsetransactiontime(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_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 (TSYSTerminalMgr Class)

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

Syntax

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

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_tsysterminalmgr_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_tsysterminalmgr_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_tsysterminalmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysterminalmgr_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 (TSYSTerminalMgr Class)

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

Syntax

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

char* dpaymentssdk_tsysterminalmgr_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertissuer(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsysterminalmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_tsysterminalmgr_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_tsysterminalmgr_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_tsysterminalmgr_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertusage(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertversion(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_tsysterminalmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsysterminalmgr_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 (TSYSTerminalMgr 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_tsysterminalmgr_getsslprovider(void* lpObj);
int dpaymentssdk_tsysterminalmgr_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 (TSYSTerminalMgr Class)

The server certificate for the last established connection.

Syntax

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_tsysterminalmgr_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertsignaturealgorithm(void* lpObj);

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

char* dpaymentssdk_tsysterminalmgr_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertusage(void* lpObj);

int dpaymentssdk_tsysterminalmgr_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertversion(void* lpObj);

char* dpaymentssdk_tsysterminalmgr_getsslservercertsubject(void* lpObj);

int dpaymentssdk_tsysterminalmgr_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 (TSYSTerminalMgr 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_tsysterminalmgr_gettimeout(void* lpObj);
int dpaymentssdk_tsysterminalmgr_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

TransactionNumber Property (TSYSTerminalMgr 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_tsysterminalmgr_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsysterminalmgr_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

AuthenticateDevice Method (TSYSTerminalMgr Class)

Authenticates a POS terminal.

Syntax

ANSI (Cross Platform)
int AuthenticateDevice();

Unicode (Windows)
INT AuthenticateDevice();

int dpaymentssdk_tsysterminalmgr_authenticatedevice(void* lpObj);

int AuthenticateDevice();

Remarks

The following Merchant fields are applicable when calling this method:

BankId
CategoryCode
CountryCode
CurrencyCode
Language
Number
ServicePhone
StoreNumber
TerminalNumber
TimeZone
Zip

The following additional properties are also applicable:

AuthenticationCode
TransactionNumber
DeviceCode
IndustryType

In addition to GenKey the following Response fields are populated:

Code
TransactionDate
TransactionNumber
TransactionTime
AuthSource
Text

AuthenticateDevice Example:

  Copy
TSYSTerminalMgr1.Merchant.BankId = "999999";
TSYSTerminalMgr1.Merchant.CategoryCode = "9999";
TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT";
TSYSTerminalMgr1.Merchant.Number = "888000002447";
TSYSTerminalMgr1.Merchant.StoreNumber = "5999";
TSYSTerminalMgr1.Merchant.TerminalNumber = "1234";
TSYSTerminalMgr1.Merchant.Zip = "27516";
TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807";
TSYSTerminalMgr1.TransactionNumber = 1234;
TSYSTerminalMgr1.AuthenticationCode = "N123456789";
TSYSTerminalMgr1.AuthenticateDevice();

string genkey = "";
if (TSYSTerminalMgr1.Response.Code == "A1") //approved
  genkey = TSYSTerminalMgr1.GenKey;

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

Config Method (TSYSTerminalMgr Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_tsysterminalmgr_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.

DeactivateDevice Method (TSYSTerminalMgr Class)

Deactivates a POS terminal.

Syntax

ANSI (Cross Platform)
int DeactivateDevice();

Unicode (Windows)
INT DeactivateDevice();

int dpaymentssdk_tsysterminalmgr_deactivatedevice(void* lpObj);

int DeactivateDevice();

Remarks

DeactivateDevice is used to deactivate a previously activated terminal identified by GenKey.

The following Merchant fields are applicable when calling this method:

BankId
CategoryCode
CountryCode
CurrencyCode
Language
Number
ServicePhone
StoreNumber
TerminalNumber
TimeZone
Zip

The following additional properties are also applicable:

GenKey
TransactionNumber
DeviceCode
IndustryType

After calling this method check Code and confirm it is "A3" to indicate the deactivation succeeded. The following Response fields are populated:

Code
TransactionDate
TransactionNumber
TransactionTime
AuthSource
Text

DeactivateDevice Example:

  Copy
TSYSTerminalMgr1.Merchant.BankId = "999999";
TSYSTerminalMgr1.Merchant.CategoryCode = "9999";
TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT";
TSYSTerminalMgr1.Merchant.Number = "888000002447";
TSYSTerminalMgr1.Merchant.StoreNumber = "5999";
TSYSTerminalMgr1.Merchant.TerminalNumber = "1234";
TSYSTerminalMgr1.Merchant.Zip = "27516";
TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807";
TSYSTerminalMgr1.TransactionNumber = 1234;
TSYSTerminalMgr1.GenKey = "MY_GEN_KEY";
TSYSTerminalMgr1.DeactivateDevice();

if (TSYSTerminalMgr1.Response.Code == "A3") //deactivated
  //...

Error Handling (C++)

Interrupt Method (TSYSTerminalMgr Class)

Interrupts the current action.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_tsysterminalmgr_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

Reset Method (TSYSTerminalMgr Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsysterminalmgr_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

Connected Event (TSYSTerminalMgr Class)

Fired immediately after a connection completes (or fails).

Syntax

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

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


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

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

#define EID_TSYSTERMINALMGR_CONNECTED 1

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

class TSYSTerminalMgrConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass TSYSTerminalMgr and override this emitter function.
virtual int FireConnected(TSYSTerminalMgrConnectedEventParams *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 (TSYSTerminalMgr Class)

Fired when receiving a data packet from the transaction server.

Syntax

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

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


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

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

#define EID_TSYSTERMINALMGR_DATAPACKETIN 2

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

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

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

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

// Or, subclass TSYSTerminalMgr and override this emitter function.
virtual int FireDataPacketIn(TSYSTerminalMgrDataPacketInEventParams *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 (TSYSTerminalMgr Class)

Fired when sending a data packet to the transaction server.

Syntax

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

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


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

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

#define EID_TSYSTERMINALMGR_DATAPACKETOUT 3

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

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

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

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

// Or, subclass TSYSTerminalMgr and override this emitter function.
virtual int FireDataPacketOut(TSYSTerminalMgrDataPacketOutEventParams *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 (TSYSTerminalMgr Class)

Fired when a connection is closed.

Syntax

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

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


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

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

#define EID_TSYSTERMINALMGR_DISCONNECTED 4

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

class TSYSTerminalMgrDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass TSYSTerminalMgr and override this emitter function.
virtual int FireDisconnected(TSYSTerminalMgrDisconnectedEventParams *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 (TSYSTerminalMgr Class)

Information about errors during data delivery.

Syntax

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

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


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

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

#define EID_TSYSTERMINALMGR_ERROR 5

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

class TSYSTerminalMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass TSYSTerminalMgr and override this emitter function.
virtual int FireError(TSYSTerminalMgrErrorEventParams *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.

SSLServerAuthentication Event (TSYSTerminalMgr Class)

Fired after the server presents its certificate to the client.

Syntax

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

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


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

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

#define EID_TSYSTERMINALMGR_SSLSERVERAUTHENTICATION 6

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

class TSYSTerminalMgrSSLServerAuthenticationEventParams {
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(TSYSTerminalMgrSSLServerAuthenticationEventParams *e);

// Or, subclass TSYSTerminalMgr and override this emitter function.
virtual int FireSSLServerAuthentication(TSYSTerminalMgrSSLServerAuthenticationEventParams *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 (TSYSTerminalMgr Class)

Fired when secure connection progress messages are available.

Syntax

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

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


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

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

#define EID_TSYSTERMINALMGR_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

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 (TSYSTerminalMgr 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.

TSYSTerminalMgr Config Settings

Port: The port to which transactions are posted.

This is port that this class connects to on the server. The default value for TSYS is 5003 for the live server, and 5004 for the test server. The default live server values for Heartland is 22341 for Authorization and 22342 for Settlement. The Heartland test server values are 12341 for Authorization and 12342 for Settlement.

Server: The server to which transactions are posted.

This is name of the server to which all transactions are posted. Do not use an IP address, use the actual name, as a server's IP address may change. The default (Live) TSYS server is "ssl2.vitalps.net", but you may use "ssltest.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.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

  Copy
Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

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

ProxyPassword: A password if authentication is to be used for the proxy.

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

ProxyPort: Port for the proxy server (default 80).

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

ProxyServer: Name or IP address of a proxy server (optional).

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

ProxyUser: A user name if authentication is to be used for the proxy.

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

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET

  Copy
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));

C++

  Copy
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

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.