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:
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 properties are applicable when calling this method:
- MerchantBankId
- MerchantCategoryCode
- MerchantCountryCode
- MerchantCurrencyCode
- MerchantLanguage
- MerchantNumber
- MerchantServicePhone
- MerchantStoreNumber
- MerchantTerminalNumber
- MerchantTimeZone
- MerchantZip
After calling this method check ResponseCode to determine if the authentication succeeded. If the authentication succeeded ResponseCode will be "A1" and GenKey will be populated. If authentication failed ResponseCode will be "A2".
In addition to GenKey the following Response properties are populated:
- ResponseCode
- ResponseTransactionDate
- ResponseTransactionNumber
- ResponseTransactionTime
- ResponseAuthSource
- ResponseText
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:
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 properties are applicable when calling this method:
- MerchantBankId
- MerchantCategoryCode
- MerchantCountryCode
- MerchantCurrencyCode
- MerchantLanguage
- MerchantNumber
- MerchantServicePhone
- MerchantStoreNumber
- MerchantTerminalNumber
- MerchantTimeZone
- MerchantZip
After calling this method check ResponseCode and confirm it is "A3" to indicate the deactivation succeeded. The following Response properties are populated:
- ResponseCode
- ResponseTransactionDate
- ResponseTransactionNumber
- ResponseTransactionTime
- ResponseAuthSource
- ResponseText
DeactivateDevice Example:
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. |
MerchantBankId | The number which identifies the merchant's bank or processor. |
MerchantCategoryCode | Classifies a merchant by the type of store. |
MerchantCity | Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. |
MerchantCountryCode | Identifies the country where the merchant is located. |
MerchantCurrencyCode | Identifies the type of currency used by the merchant. |
MerchantLanguage | Designates the language that response messages will be returned in. |
MerchantName | Name of the merchant. |
MerchantNumber | A unique number used to identify the merchant within the VisaNet system. |
MerchantPhone | Merchant's phone number. |
MerchantServicePhone | Merchant's customer service number. |
MerchantState | State or province that the merchant is located in. |
MerchantStoreNumber | Used to identify a specific merchant's store within the VisaNet system. |
MerchantStreetAddress | Merchant's street address. |
MerchantTerminalNumber | Used to identify a unique terminal within a merchant location. |
MerchantTimeZone | Specifies the GMT offset used to calculate the local time within the VisaNet system. |
MerchantZip | Zip code where the merchant that initiated this transaction is located. |
ResponseApprovalCode | Contains an authorization code when a transaction has been approved. |
ResponseAuthorizedAmount | Amount actually used from the card (used when supporting partial redemptions). |
ResponseAuthSource | Indicates the source of the authorization code stored in ApprovalCode . |
ResponseAVSResult | Contains the Address Verification System result code. |
ResponseCardLevel | This property contains a two-character code created by Visa during the authorization process. |
ResponseCode | Indicates the status of the authorization request. |
ResponseCommercialCardType | Response property that indicates whether the card is a commercial card. |
ResponseCVVResult | Contains the returned CVV result code if it was requested. |
ResponseRetrievalNumber | This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement. |
ResponseReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
ResponseText | Text information that describes each response code. |
ResponseTransactionDate | Local transaction date returned from the server in MMddyy format. |
ResponseTransactionId | Contains the Transaction Identifier or MasterCard Reference Number. |
ResponseTransactionNumber | Check this property against the original Transaction Number. |
ResponseTransactionTime | Local transaction time returned from the server in HHmmss format. |
ResponseValidationCode | This optional property contains information generated by the card issuer. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
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 certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
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 certificate 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. |
MaskSensitive | 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
1
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
MerchantBankId Property (TSYSTerminalMgr Class)
The number which identifies the merchant's bank or processor.
Syntax
ANSI (Cross Platform) char* GetMerchantBankId();
int SetMerchantBankId(const char* lpszMerchantBankId); Unicode (Windows) LPWSTR GetMerchantBankId();
INT SetMerchantBankId(LPCWSTR lpszMerchantBankId);
char* dpaymentssdk_tsysterminalmgr_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);
QString GetMerchantBankId();
int SetMerchantBankId(QString qsMerchantBankId);
Default Value
""
Remarks
The number which identifies the merchant's bank or processor.
This property 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 property may not remain zero-filled.
Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber 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.
Data Type
String
MerchantCategoryCode Property (TSYSTerminalMgr Class)
Classifies a merchant by the type of store.
Syntax
ANSI (Cross Platform) char* GetMerchantCategoryCode();
int SetMerchantCategoryCode(const char* lpszMerchantCategoryCode); Unicode (Windows) LPWSTR GetMerchantCategoryCode();
INT SetMerchantCategoryCode(LPCWSTR lpszMerchantCategoryCode);
char* dpaymentssdk_tsysterminalmgr_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);
QString GetMerchantCategoryCode();
int SetMerchantCategoryCode(QString qsMerchantCategoryCode);
Default Value
""
Remarks
Classifies a merchant by the type of store.
This four digit property 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).
Data Type
String
MerchantCity Property (TSYSTerminalMgr Class)
Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
Syntax
ANSI (Cross Platform) char* GetMerchantCity();
int SetMerchantCity(const char* lpszMerchantCity); Unicode (Windows) LPWSTR GetMerchantCity();
INT SetMerchantCity(LPCWSTR lpszMerchantCity);
char* dpaymentssdk_tsysterminalmgr_getmerchantcity(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcity(void* lpObj, const char* lpszMerchantCity);
QString GetMerchantCity();
int SetMerchantCity(QString qsMerchantCity);
Default Value
""
Remarks
Merchant's City
For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. This is an optional property. However if it is specified, the MerchantName and MerchantState must also be specified.
The first character of this property may not be a space and must contain the same data used in the batch settlement.
Note that this property is ignored for Direct Marketing and E-Commerce transactions. MerchantServicePhone is used for those industries instead of MerchantCity.
This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.
Data Type
String
MerchantCountryCode Property (TSYSTerminalMgr Class)
Identifies the country where the merchant is located.
Syntax
ANSI (Cross Platform) char* GetMerchantCountryCode();
int SetMerchantCountryCode(const char* lpszMerchantCountryCode); Unicode (Windows) LPWSTR GetMerchantCountryCode();
INT SetMerchantCountryCode(LPCWSTR lpszMerchantCountryCode);
char* dpaymentssdk_tsysterminalmgr_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);
QString GetMerchantCountryCode();
int SetMerchantCountryCode(QString qsMerchantCountryCode);
Default Value
"840"
Remarks
Identifies the country where the merchant is located.
This property 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".
Data Type
String
MerchantCurrencyCode Property (TSYSTerminalMgr Class)
Identifies the type of currency used by the merchant.
Syntax
ANSI (Cross Platform) char* GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(const char* lpszMerchantCurrencyCode); Unicode (Windows) LPWSTR GetMerchantCurrencyCode();
INT SetMerchantCurrencyCode(LPCWSTR lpszMerchantCurrencyCode);
char* dpaymentssdk_tsysterminalmgr_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);
QString GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(QString qsMerchantCurrencyCode);
Default Value
"840"
Remarks
Identifies the type of currency used by the merchant.
This property contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".
Data Type
String
MerchantLanguage Property (TSYSTerminalMgr Class)
Designates the language that response messages will be returned in.
Syntax
ANSI (Cross Platform) char* GetMerchantLanguage();
int SetMerchantLanguage(const char* lpszMerchantLanguage); Unicode (Windows) LPWSTR GetMerchantLanguage();
INT SetMerchantLanguage(LPCWSTR lpszMerchantLanguage);
char* dpaymentssdk_tsysterminalmgr_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);
QString GetMerchantLanguage();
int SetMerchantLanguage(QString qsMerchantLanguage);
Default Value
"00"
Remarks
Designates the language that response messages will be returned in.
This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property 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. |
Data Type
String
MerchantName Property (TSYSTerminalMgr Class)
Name of the merchant.
Syntax
ANSI (Cross Platform) char* GetMerchantName();
int SetMerchantName(const char* lpszMerchantName); Unicode (Windows) LPWSTR GetMerchantName();
INT SetMerchantName(LPCWSTR lpszMerchantName);
char* dpaymentssdk_tsysterminalmgr_getmerchantname(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantname(void* lpObj, const char* lpszMerchantName);
QString GetMerchantName();
int SetMerchantName(QString qsMerchantName);
Default Value
""
Remarks
Name of the merchant.
This 25 character property 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 property may not be a space. This property must contain the same value in both authorization and batch settlement.
This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.
This property may contain alphanumeric and punctuation characters. The maximum length of this property is 25 characters.
Data Type
String
MerchantNumber Property (TSYSTerminalMgr Class)
A unique number used to identify the merchant within the VisaNet system.
Syntax
ANSI (Cross Platform) char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber); Unicode (Windows) LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);
char* dpaymentssdk_tsysterminalmgr_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);
QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);
Default Value
""
Remarks
A unique number used to identify the merchant within the VisaNet system.
This 12 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This property is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.
Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber 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.
Data Type
String
MerchantPhone Property (TSYSTerminalMgr Class)
Merchant's phone number.
Syntax
ANSI (Cross Platform) char* GetMerchantPhone();
int SetMerchantPhone(const char* lpszMerchantPhone); Unicode (Windows) LPWSTR GetMerchantPhone();
INT SetMerchantPhone(LPCWSTR lpszMerchantPhone);
char* dpaymentssdk_tsysterminalmgr_getmerchantphone(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);
QString GetMerchantPhone();
int SetMerchantPhone(QString qsMerchantPhone);
Default Value
""
Remarks
Merchant's phone number.
This property contains the Merchant's business phone number. This can be the same as the customer service phone number.
Data Type
String
MerchantServicePhone Property (TSYSTerminalMgr Class)
Merchant's customer service number.
Syntax
ANSI (Cross Platform) char* GetMerchantServicePhone();
int SetMerchantServicePhone(const char* lpszMerchantServicePhone); Unicode (Windows) LPWSTR GetMerchantServicePhone();
INT SetMerchantServicePhone(LPCWSTR lpszMerchantServicePhone);
char* dpaymentssdk_tsysterminalmgr_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);
QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone);
Default Value
""
Remarks
Merchant's customer service number.
This property 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 property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.
Data Type
String
MerchantState Property (TSYSTerminalMgr Class)
State or province that the merchant is located in.
Syntax
ANSI (Cross Platform) char* GetMerchantState();
int SetMerchantState(const char* lpszMerchantState); Unicode (Windows) LPWSTR GetMerchantState();
INT SetMerchantState(LPCWSTR lpszMerchantState);
char* dpaymentssdk_tsysterminalmgr_getmerchantstate(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantstate(void* lpObj, const char* lpszMerchantState);
QString GetMerchantState();
int SetMerchantState(QString qsMerchantState);
Default Value
""
Remarks
State or province that the merchant is located in.
This two character property contains the merchant state or province provided by the signing member or processor. This property must contain the same data used in the batch settlement.
This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.
Data Type
String
MerchantStoreNumber Property (TSYSTerminalMgr Class)
Used to identify a specific merchant's store within the VisaNet system.
Syntax
ANSI (Cross Platform) char* GetMerchantStoreNumber();
int SetMerchantStoreNumber(const char* lpszMerchantStoreNumber); Unicode (Windows) LPWSTR GetMerchantStoreNumber();
INT SetMerchantStoreNumber(LPCWSTR lpszMerchantStoreNumber);
char* dpaymentssdk_tsysterminalmgr_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);
QString GetMerchantStoreNumber();
int SetMerchantStoreNumber(QString qsMerchantStoreNumber);
Default Value
""
Remarks
Used to identify a specific merchant's store within the VisaNet system.
This four digit property contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This property must be right-justified and zero-filled.
Data Type
String
MerchantStreetAddress Property (TSYSTerminalMgr Class)
Merchant's street address.
Syntax
ANSI (Cross Platform) char* GetMerchantStreetAddress();
int SetMerchantStreetAddress(const char* lpszMerchantStreetAddress); Unicode (Windows) LPWSTR GetMerchantStreetAddress();
INT SetMerchantStreetAddress(LPCWSTR lpszMerchantStreetAddress);
char* dpaymentssdk_tsysterminalmgr_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);
QString GetMerchantStreetAddress();
int SetMerchantStreetAddress(QString qsMerchantStreetAddress);
Default Value
""
Remarks
Merchant's street address.
This 25 character property 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.
Data Type
String
MerchantTerminalNumber Property (TSYSTerminalMgr Class)
Used to identify a unique terminal within a merchant location.
Syntax
ANSI (Cross Platform) char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber); Unicode (Windows) LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);
char* dpaymentssdk_tsysterminalmgr_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);
QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);
Default Value
""
Remarks
Used to identify a unique terminal within a merchant location.
This four digit property 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 property 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 property must be right-justified and zero-filled.
Data Type
String
MerchantTimeZone Property (TSYSTerminalMgr Class)
Specifies the GMT offset used to calculate the local time within the VisaNet system.
Syntax
ANSI (Cross Platform) char* GetMerchantTimeZone();
int SetMerchantTimeZone(const char* lpszMerchantTimeZone); Unicode (Windows) LPWSTR GetMerchantTimeZone();
INT SetMerchantTimeZone(LPCWSTR lpszMerchantTimeZone);
char* dpaymentssdk_tsysterminalmgr_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);
QString GetMerchantTimeZone();
int SetMerchantTimeZone(QString qsMerchantTimeZone);
Default Value
"705"
Remarks
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. |
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.
Data Type
String
MerchantZip Property (TSYSTerminalMgr Class)
Zip code where the merchant that initiated this transaction is located.
Syntax
ANSI (Cross Platform) char* GetMerchantZip();
int SetMerchantZip(const char* lpszMerchantZip); Unicode (Windows) LPWSTR GetMerchantZip();
INT SetMerchantZip(LPCWSTR lpszMerchantZip);
char* dpaymentssdk_tsysterminalmgr_getmerchantzip(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setmerchantzip(void* lpObj, const char* lpszMerchantZip);
QString GetMerchantZip();
int SetMerchantZip(QString qsMerchantZip);
Default Value
""
Remarks
Zip code where the merchant that initiated this transaction is located.
This property 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 property will be assigned by the signing member or processor.
This property is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.
Data Type
String
ResponseApprovalCode Property (TSYSTerminalMgr Class)
Contains an authorization code when a transaction has been approved.
Syntax
ANSI (Cross Platform) char* GetResponseApprovalCode(); Unicode (Windows) LPWSTR GetResponseApprovalCode();
char* dpaymentssdk_tsysterminalmgr_getresponseapprovalcode(void* lpObj);
QString GetResponseApprovalCode();
Default Value
""
Remarks
Contains an authorization code when a transaction has been approved.
This six character property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction has not been approved, then the contents of the property should be ignored. The ResponseApprovalCode must be stored and submitted in the settlement data capture record.
This property is read-only and not available at design time.
Data Type
String
ResponseAuthorizedAmount Property (TSYSTerminalMgr Class)
Amount actually used from the card (used when supporting partial redemptions).
Syntax
ANSI (Cross Platform) char* GetResponseAuthorizedAmount(); Unicode (Windows) LPWSTR GetResponseAuthorizedAmount();
char* dpaymentssdk_tsysterminalmgr_getresponseauthorizedamount(void* lpObj);
QString GetResponseAuthorizedAmount();
Default Value
""
Remarks
Amount actually used from the card (used when supporting partial redemptions).
The ResponseAuthorizedAmount 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 ResponseAuthorizedAmount 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 ResponseAuthorizedAmount will represent the approved amount of $7.50.In this case, the ResponseCode will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the ResponseAuthorizedAmount 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 property 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.
This property is read-only.
Data Type
String
ResponseAuthSource Property (TSYSTerminalMgr Class)
Indicates the source of the authorization code stored in ApprovalCode .
Syntax
ANSI (Cross Platform) char* GetResponseAuthSource(); Unicode (Windows) LPWSTR GetResponseAuthSource();
char* dpaymentssdk_tsysterminalmgr_getresponseauthsource(void* lpObj);
QString GetResponseAuthSource();
Default Value
""
Remarks
Indicates the source of the authorization code stored in ResponseApprovalCode.
This property contains a one character code indicating the source of the ResponseApprovalCode. 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) |
This property is read-only and not available at design time.
Data Type
String
ResponseAVSResult Property (TSYSTerminalMgr Class)
Contains the Address Verification System result code.
Syntax
ANSI (Cross Platform) char* GetResponseAVSResult(); Unicode (Windows) LPWSTR GetResponseAVSResult();
char* dpaymentssdk_tsysterminalmgr_getresponseavsresult(void* lpObj);
QString GetResponseAVSResult();
Default Value
""
Remarks
Contains the Address Verification System result code.
This one character property 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
This property is read-only and not available at design time.
Data Type
String
ResponseCardLevel Property (TSYSTerminalMgr Class)
This property contains a two-character code created by Visa during the authorization process.
Syntax
ANSI (Cross Platform) char* GetResponseCardLevel(); Unicode (Windows) LPWSTR GetResponseCardLevel();
char* dpaymentssdk_tsysterminalmgr_getresponsecardlevel(void* lpObj);
QString GetResponseCardLevel();
Default Value
""
Remarks
This property 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.
This property is read-only and not available at design time.
Data Type
String
ResponseCode Property (TSYSTerminalMgr Class)
Indicates the status of the authorization request.
Syntax
ANSI (Cross Platform) char* GetResponseCode(); Unicode (Windows) LPWSTR GetResponseCode();
char* dpaymentssdk_tsysterminalmgr_getresponsecode(void* lpObj);
QString GetResponseCode();
Default Value
""
Remarks
Indicates the status of the authorization request.
This property 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 ResponseText 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 ResponseCodes are listed in the table of contents.
This property is read-only and not available at design time.
Data Type
String
ResponseCommercialCardType Property (TSYSTerminalMgr Class)
Response property that indicates whether the card is a commercial card.
Syntax
ANSI (Cross Platform) int GetResponseCommercialCardType(); Unicode (Windows) INT GetResponseCommercialCardType();
Possible Values
TCC_NOT_COMMERCIAL(0),
TCC_BUSINESS_CARD(1),
TCC_VISA_COMMERCE(2),
TCC_CORPORATE_CARD(3),
TCC_PURCHASE_CARD(4)
int dpaymentssdk_tsysterminalmgr_getresponsecommercialcardtype(void* lpObj);
int GetResponseCommercialCardType();
Default Value
0
Remarks
Response property 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 property 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 property 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 |
This property is only valid after a successful authorization request and response.
This property is read-only and not available at design time.
Data Type
Integer
ResponseCVVResult Property (TSYSTerminalMgr Class)
Contains the returned CVV result code if it was requested.
Syntax
ANSI (Cross Platform) char* GetResponseCVVResult(); Unicode (Windows) LPWSTR GetResponseCVVResult();
char* dpaymentssdk_tsysterminalmgr_getresponsecvvresult(void* lpObj);
QString GetResponseCVVResult();
Default Value
""
Remarks
Contains the returned CVV result code if it was requested.
If a CVV value was sent in the authorization request, then this one character property 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 ResponseText 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. |
This property is read-only and not available at design time.
Data Type
String
ResponseRetrievalNumber Property (TSYSTerminalMgr Class)
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
Syntax
ANSI (Cross Platform) char* GetResponseRetrievalNumber(); Unicode (Windows) LPWSTR GetResponseRetrievalNumber();
char* dpaymentssdk_tsysterminalmgr_getresponseretrievalnumber(void* lpObj);
QString GetResponseRetrievalNumber();
Default Value
""
Remarks
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
This property 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.
This property is read-only and not available at design time.
Data Type
String
ResponseReturnedACI Property (TSYSTerminalMgr Class)
Returned Authorization Characteristics Indicator contains CPS qualification status.
Syntax
ANSI (Cross Platform) char* GetResponseReturnedACI(); Unicode (Windows) LPWSTR GetResponseReturnedACI();
char* dpaymentssdk_tsysterminalmgr_getresponsereturnedaci(void* lpObj);
QString GetResponseReturnedACI();
Default Value
""
Remarks
Returned Authorization Characteristics Indicator contains CPS qualification status.
This one character property 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 property and submit it in the batch settlement. The POS system should not interpret any relationship between this property and the presence of data in either the ResponseTransactionId or ResponseValidationCode properties.
This property is read-only and not available at design time.
Data Type
String
ResponseText Property (TSYSTerminalMgr Class)
Text information that describes each response code.
Syntax
ANSI (Cross Platform) char* GetResponseText(); Unicode (Windows) LPWSTR GetResponseText();
char* dpaymentssdk_tsysterminalmgr_getresponsetext(void* lpObj);
QString GetResponseText();
Default Value
""
Remarks
Text information that describes each response code.
This property 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.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionDate Property (TSYSTerminalMgr Class)
Local transaction date returned from the server in MMddyy format.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionDate(); Unicode (Windows) LPWSTR GetResponseTransactionDate();
char* dpaymentssdk_tsysterminalmgr_getresponsetransactiondate(void* lpObj);
QString GetResponseTransactionDate();
Default Value
""
Remarks
Local transaction date returned from the server in MMddyy format.
This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionId Property (TSYSTerminalMgr Class)
Contains the Transaction Identifier or MasterCard Reference Number.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionId(); Unicode (Windows) LPWSTR GetResponseTransactionId();
char* dpaymentssdk_tsysterminalmgr_getresponsetransactionid(void* lpObj);
QString GetResponseTransactionId();
Default Value
""
Remarks
Contains the Transaction Identifier or MasterCard Reference Number.
This 15-character property 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 property. Data returned in this property (if any) should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionNumber Property (TSYSTerminalMgr Class)
Check this property against the original Transaction Number.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionNumber(); Unicode (Windows) LPWSTR GetResponseTransactionNumber();
char* dpaymentssdk_tsysterminalmgr_getresponsetransactionnumber(void* lpObj);
QString GetResponseTransactionNumber();
Default Value
""
Remarks
Check this property against the original Transaction Number.
This property 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 property should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionTime Property (TSYSTerminalMgr Class)
Local transaction time returned from the server in HHmmss format.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionTime(); Unicode (Windows) LPWSTR GetResponseTransactionTime();
char* dpaymentssdk_tsysterminalmgr_getresponsetransactiontime(void* lpObj);
QString GetResponseTransactionTime();
Default Value
""
Remarks
Local transaction time returned from the server in HHmmss format.
This six digit property contains the Local Transaction Time returned by the authorizing system. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseValidationCode Property (TSYSTerminalMgr Class)
This optional property contains information generated by the card issuer.
Syntax
ANSI (Cross Platform) char* GetResponseValidationCode(); Unicode (Windows) LPWSTR GetResponseValidationCode();
char* dpaymentssdk_tsysterminalmgr_getresponsevalidationcode(void* lpObj);
QString GetResponseValidationCode();
Default Value
""
Remarks
This optional property contains information generated by the card issuer.
This optional four character property 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 property. Data returned in this property should be recorded and submitted as part of a Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
SSLAcceptServerCertEncoded Property (TSYSTerminalMgr Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysterminalmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysterminalmgr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (TSYSTerminalMgr Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int dpaymentssdk_tsysterminalmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsysterminalmgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (TSYSTerminalMgr Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int dpaymentssdk_tsysterminalmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsysterminalmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (TSYSTerminalMgr Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* dpaymentssdk_tsysterminalmgr_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (TSYSTerminalMgr Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int dpaymentssdk_tsysterminalmgr_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is 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 property 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 SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLCertSubject Property (TSYSTerminalMgr Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* dpaymentssdk_tsysterminalmgr_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsysterminalmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is 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 property 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=support@nsoftware.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.
Data Type
String
SSLProvider Property (TSYSTerminalMgr Class)
This specifies the 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
0
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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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
SSLServerCertEncoded Property (TSYSTerminalMgr Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded); Unicode (Windows) INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int dpaymentssdk_tsysterminalmgr_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
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
30
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
0
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 ResponseTransactionNumber 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
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 properties are applicable when calling this method:
- MerchantBankId
- MerchantCategoryCode
- MerchantCountryCode
- MerchantCurrencyCode
- MerchantLanguage
- MerchantNumber
- MerchantServicePhone
- MerchantStoreNumber
- MerchantTerminalNumber
- MerchantTimeZone
- MerchantZip
After calling this method check ResponseCode to determine if the authentication succeeded. If the authentication succeeded ResponseCode will be "A1" and GenKey will be populated. If authentication failed ResponseCode will be "A2".
In addition to GenKey the following Response properties are populated:
- ResponseCode
- ResponseTransactionDate
- ResponseTransactionNumber
- ResponseTransactionTime
- ResponseAuthSource
- ResponseText
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 properties are applicable when calling this method:
- MerchantBankId
- MerchantCategoryCode
- MerchantCountryCode
- MerchantCurrencyCode
- MerchantLanguage
- MerchantNumber
- MerchantServicePhone
- MerchantStoreNumber
- MerchantTerminalNumber
- MerchantTimeZone
- MerchantZip
After calling this method check ResponseCode and confirm it is "A3" to indicate the deactivation succeeded. The following Response properties are populated:
- ResponseCode
- ResponseTransactionDate
- ResponseTransactionNumber
- ResponseTransactionTime
- ResponseAuthSource
- ResponseText
DeactivateDevice Example:
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++)
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.)
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++)
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.)
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++)
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.)
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.
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
HTTP Config Settings
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.
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.
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]".
The default value is False.
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
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
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.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
Note: This setting is applicable only to Mac/iOS editions.
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.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
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.
In multi-homed 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 multi-homed hosts (machines with more than one IP interface).
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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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 setting has no effect if SSLProvider is set to Platform.
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 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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".
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.
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.
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:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
Please note that this 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 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 config setting.
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:
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:
- 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
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_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- 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.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - 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 which 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 only supported 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 only available 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 the above 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.
This setting is only applicable when SSLProvider is set to Internal.
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.
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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (TSYSTerminalMgr Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
TSYSTerminalMgr Errors
501 Data field invalid length. | |
502 Data field invalid format. | |
503 Data field out of range. | |
504 Luhn digit check failed. | |
505 Card date invalid. | |
506 Card expired. | |
507 Card type unknown. | |
509 No gateway specified. | |
511 Invalid data entered. | |
512 Truncated response. | |
513 Invalid response. | |
517 Response length mismatch. | |
518 LRC check failed. | |
519 Corrupt response. | |
520 Response packet empty. | |
521 Response truncated. | |
522 Host disconnected. | |
523 No response from host. | |
524 Server error response. | |
526 Invalid timeout value. | |
527 Vital/TSYS returned an error response. | |
535 Signature verification failed. | |
544 Error building packet. | |
593 Missing or erroneous property value. Cannot send transaction. | |
594 Response received before transmission completed. | |
595 Prematurely disconnected (check MerchantNumber and MerchantBankId). | |
596 Pending responses max number exceeded (Interleaved). | |
597 Pending response timeout (Interleaved). |