TSYSSettle Class
Properties Methods Events Config Settings Errors
The TSYSSettle class is used to do a Batch Settlement on all transactions that were successfully authorized with the TSYSECOMMERCE or TSYSRETAIL classes. This class may also send Level II and Level III Corporate Purchasing Card data for better interchange rates.
Syntax
TSYSSettle
Remarks
This class allows for a direct, secure connection to the Vital/TSYS gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers. The TSYSSettle class is used to settle all transactions previously authorized by the TSYSECommerce or TSYSRetail class. When a transaction is authorized, money in the customer's account is blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions are settled with the TSYSSettle class the funds are deducted from the customer's account and added to the merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement.
To send a Batch Settlement, first the user must fill out the Merchant properties with the same information contained in the authorizing class's Merchant properties.
TSYSSettle.MerchantBankId = "999995"
TSYSSettle.MerchantCategoryCode = "5999"
TSYSSettle.MerchantName = "test merchant"
TSYSSettle.MerchantNumber = "123456789012"
TSYSSettle.MerchantCity = "Beverly Hills"
TSYSSettle.MerchantState = "CA"
TSYSSettle.MerchantStoreNumber = "5999"
TSYSSettle.MerchantTerminalNumber = "1515"
TSYSSettle.MerchantZip = "90210"Additionally, the AgentBankNumber, AgentChainNumber, TerminalId, BatchNumber, and IndustryType must be set. Note that the TerminalId is fundamentally different from the TerminalNumber. The TerminalNumber is used to identify a unique terminal (PC, server, whatever) within a merchant location. The TerminalId, also known as the "V Number", is used for point-of-sale tracking.
TSYSSettle.AgentBankNumber = "000000"
TSYSSettle.AgentChainNumber = "111111"
TSYSSettle.TerminalId = "00000001"
TSYSSettle.BatchNumber = 15
TSYSSettle.IndustryType = itRetailAt this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the DetailAggregate array property. First set the DetailRecordCount; to the total number of transactions you wish to settle. Each index in the DetailAggregate array property must be set with the XML aggregate returned from the TSYSRetail, TSYSECommerce, or TSYSDetailRecord class's GetDetailAggregate method.
TSYSSettle.DetailRecordCount = 1
TSYSSettle.DetailAggregate(0) = TSYSRetail.GetDetailAggregate()Finally, call the SendSettlement method.
TSYSSettle.SendSettlement()If the transaction is successful, the Code will contain "GB", which indicates a "Good Batch". You should check that the NetDeposit and RecordCount match the NetDeposit and RecordCount fields.
If the transaction is not successful and you receive an "RB" Code (indicating a "Rejected Batch") the class fails with an error. You may inspect the Data. DataFieldNumber, RecordType, SequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.
Thousands of detail records may be settled in the above manner, just by increasing the DetailRecordCount and adding a transaction to each index of the DetailAggregate property. However it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.
To Void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. Credits and forced transactions may be created using the TSYSDetailRecord class and settled in the same manner.
To add Level II or Level III data to the settled transactions, use the AddendumAggregate field and the TSYSLevel2 or TSYSLevel3 classs.
Note that the IndustryType from the TSYSSettle class MUST match the detail record aggregate of EACH transaction that is added to the settlement. You cannot mix industry types in a batch - you must settle a separate batch for each industry type.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| AgentBankNumber | Identifies a specific agent entity of the member bank or processor. |
| AgentChainNumber | Identifies a specific chain of an agent organization. |
| Batch | Contains information about the batch settlement, as computed by the class. |
| BatchNumber | Sequence number of this batch transaction. |
| DetailRecords | Collection of detail records to send in the settlement. |
| Error | Contains information about settlement errors. |
| IndustryType | Code which indicates the industry the merchant is engaged in. |
| Merchant | Contains the merchant's setup information. |
| MerchantLocalPhone | Merchant's local phone number. Used in settlement only. |
| Response | Contains the response to a batch settlement. |
| SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| SSLServerCert | The server certificate for the last established connection. |
| TerminalId | Contains number to accommodate a POS device tracking number. |
| Timeout | A timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Interrupt | Interrupts the current action. |
| Reset | Resets all the properties of the entire settlement to their default values. |
| SendSettlement | Begins a Batch Settlement transaction with the transaction server. |
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.
| AmexAggregatorName | Contains the name of the Payment Service Provider/Aggregator or Facilitator participating in Amex OptBlue program. |
| CombineRecords | Whether settlement records are being concatenated into a single settlement block. |
| DeviceCode | A 1-character value used to identify the device and type of the merchant submitting the settlement batch. |
| GenKey | A randomly generated string of alphanumeric characters identifying the terminal. |
| HeartlandDeviceId | Specifies a device ID to uniquely identify each terminal (card data entry device). |
| HeartlandEncryptionMode | Specifies the encryption mode to use in Heartland transactions. |
| HeartlandKeyBlock | Specifies the key block used to encrypt the data. |
| LocationNumber | Provides additional information on the location of the merchant. |
| Port | The port to which transactions are posted. |
| Processor | Specifies the Processor you are connecting to. |
| Server | The server to which transactions are posted. |
| TravelAgencyCode | Contains the Travel Agency IATA Code if the ticket was issued by a travel agency. |
| TravelAgencyName | Contains the Travel Agency Name if the ticket was issued by a travel agency. |
| UseHTTPPOST | Tells the class whether or not to use HTTP POST when transmitting the Batch for Settlement. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AgentBankNumber Property (TSYSSettle Class)
Identifies a specific agent entity of the member bank or processor.
Syntax
ANSI (Cross Platform) char* GetAgentBankNumber();
int SetAgentBankNumber(const char* lpszAgentBankNumber); Unicode (Windows) LPWSTR GetAgentBankNumber();
INT SetAgentBankNumber(LPCWSTR lpszAgentBankNumber);
char* dpaymentssdk_tsyssettle_getagentbanknumber(void* lpObj);
int dpaymentssdk_tsyssettle_setagentbanknumber(void* lpObj, const char* lpszAgentBankNumber);
QString GetAgentBankNumber();
int SetAgentBankNumber(QString qsAgentBankNumber);
Default Value
"000000"
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purposes of identifying a specific agent entity of the member bank or processor.
This is a Header Property, and needs to be set once for a single Batch Settlement transaction.
Data Type
String
AgentChainNumber Property (TSYSSettle Class)
Identifies a specific chain of an agent organization.
Syntax
ANSI (Cross Platform) char* GetAgentChainNumber();
int SetAgentChainNumber(const char* lpszAgentChainNumber); Unicode (Windows) LPWSTR GetAgentChainNumber();
INT SetAgentChainNumber(LPCWSTR lpszAgentChainNumber);
char* dpaymentssdk_tsyssettle_getagentchainnumber(void* lpObj);
int dpaymentssdk_tsyssettle_setagentchainnumber(void* lpObj, const char* lpszAgentChainNumber);
QString GetAgentChainNumber();
int SetAgentChainNumber(QString qsAgentChainNumber);
Default Value
"000000"
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purpose of identifying a specific chain of an agent organization.
This is a Header Property, and needs to be set once for a single Batch Settlement transaction.
Data Type
String
Batch Property (TSYSSettle Class)
Contains information about the batch settlement, as computed by the class.
Syntax
DPaymentsSDKTSYSBatchInfo* GetBatch();
char* dpaymentssdk_tsyssettle_getbatchcashbacktotal(void* lpObj);
char* dpaymentssdk_tsyssettle_getbatchhashingtotal(void* lpObj);
char* dpaymentssdk_tsyssettle_getbatchnetdeposit(void* lpObj);
int dpaymentssdk_tsyssettle_getbatchrecordcount(void* lpObj);
QString GetBatchCashBackTotal(); QString GetBatchHashingTotal(); QString GetBatchNetDeposit(); int GetBatchRecordCount();
Remarks
When building a settlement, the class will calculate the fields in the table below.
| CashBackTotal | Total amount of cash back for all transactions in the batch. |
| HashingTotal | Total of purchases plus refunds. |
| NetDeposit | Total of purchases minus refunds. |
| RecordCount | Total number of records sent including Header, Parameter, and Trailer. Should be compared to the response RecordCount. |
This property is read-only.
Data Type
BatchNumber Property (TSYSSettle Class)
Sequence number of this batch transaction.
Syntax
ANSI (Cross Platform) int GetBatchNumber();
int SetBatchNumber(int iBatchNumber); Unicode (Windows) INT GetBatchNumber();
INT SetBatchNumber(INT iBatchNumber);
int dpaymentssdk_tsyssettle_getbatchnumber(void* lpObj);
int dpaymentssdk_tsyssettle_setbatchnumber(void* lpObj, int iBatchNumber);
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);
Default Value
0
Remarks
This property contains a three digit batch sequence number generated by the Point of Sale (POS) device. The batch number must be within the range "001" to "999". If the POS device is automatically incrementing the batch number, it should automatically advance the number from "999" to "001"("000" is invalid). Batch numbers must not be reused or repeated within 5 consecutive days.
This is a Header Property, and needs to be set once for a single Batch Settlement transaction.
If the transaction is successful, the Code will contain "GB", which indicates a "Good Batch". You should check that the NetDeposit and RecordCount match the NetDeposit and RecordCount fields.
If the transaction is not successful and you receive an "RB" Code (indicating a "Rejected Batch") the class fails with an error. You may inspect the Data. DataFieldNumber, RecordType, SequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.
Data Type
Integer
DetailRecords Property (TSYSSettle Class)
Collection of detail records to send in the settlement.
Syntax
DPaymentsSDKList<DPaymentsSDKTSYSRecordType>* GetDetailRecords(); int SetDetailRecords(DPaymentsSDKList<DPaymentsSDKTSYSRecordType>* val);
int dpaymentssdk_tsyssettle_getdetailrecordcount(void* lpObj);
int dpaymentssdk_tsyssettle_setdetailrecordcount(void* lpObj, int iDetailRecordCount);
char* dpaymentssdk_tsyssettle_getdetailrecordaddendum(void* lpObj, int detailrecordindex);
int dpaymentssdk_tsyssettle_setdetailrecordaddendum(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAddendum);
char* dpaymentssdk_tsyssettle_getdetailrecordaggregate(void* lpObj, int detailrecordindex);
int dpaymentssdk_tsyssettle_setdetailrecordaggregate(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAggregate);
int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount); QString GetDetailRecordAddendum(int iDetailRecordIndex);
int SetDetailRecordAddendum(int iDetailRecordIndex, QString qsDetailRecordAddendum); QString GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, QString qsDetailRecordAggregate);
Remarks
Each TSYSRecordType object in the collection specifies an xml aggregate representing the transaction to be settled. The TSYSRecordType may also specify an addenda aggregate for sending Level2 or Level2 and Level3 data. The XML aggregate to be settled is generated from the TSYSRetail, TSYSECommerce, TSYSGiftCard, TSYSBenefit, or TSYSDetailRecord class.
The following example shows how to add a detail record to the collection.
TSYSEcommerce1.Authorize();
TSYSSettle.DetailRecords.Add(new TSYSRecordType(TSYSEcommerce1.GetDetailAggregate()));Xml aggregates are used instead of directly passing Objects because it is easy to store XML aggregates in a database after authorization, and then retrieve them for settlement at the end of the business day.
Thousands of detail records may be settled in the above manner, just by adding transactions to the DetailRecords collection. However it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.
Data Type
Error Property (TSYSSettle Class)
Contains information about settlement errors.
Syntax
DPaymentsSDKTSYSBatchErrorInfo* GetError();
char* dpaymentssdk_tsyssettle_geterrordata(void* lpObj);
int dpaymentssdk_tsyssettle_geterrordatafieldnumber(void* lpObj);
int dpaymentssdk_tsyssettle_geterrordetailrecordindex(void* lpObj);
char* dpaymentssdk_tsyssettle_geterrortype(void* lpObj);
char* dpaymentssdk_tsyssettle_geterrorrecordtype(void* lpObj);
int dpaymentssdk_tsyssettle_geterrorsequencenumber(void* lpObj);
QString GetErrorData(); int GetErrorDataFieldNumber(); int GetErrorDetailRecordIndex(); QString GetErrorType(); QString GetErrorRecordType(); int GetErrorSequenceNumber();
Remarks
If there is an error in the settlement that results in a rejected batch, this type will contain information that can help you determine what has caused the settlement to fail. The following fields are available:
| Data | This contains the actual data which caused the error. |
| DataFieldNumber | Field within an individual record that contains the error. The class will attempt to determine the property in error based on the contents of this field. However, you may need to consult TSYS support and/or the current EIS-1081 documentation for more information. |
| DetailRecordIndex | Provides the index of the DetailRecord that caused the batch error. |
| ErrorType | Type of batch error. |
| RecordType | Type of record in which an error occurred (header record, detail record, etc). |
| SequenceNumber | Sequence number of the record that caused an error. |
This property is read-only.
Data Type
DPaymentsSDKTSYSBatchErrorInfo
IndustryType Property (TSYSSettle 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_tsyssettle_getindustrytype(void* lpObj);
int dpaymentssdk_tsyssettle_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
Merchant Property (TSYSSettle Class)
Contains the merchant's setup information.
Syntax
DPaymentsSDKTSYSMerchant* GetMerchant(); int SetMerchant(DPaymentsSDKTSYSMerchant* val);
char* dpaymentssdk_tsyssettle_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);
char* dpaymentssdk_tsyssettle_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);
char* dpaymentssdk_tsyssettle_getmerchantcity(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcity(void* lpObj, const char* lpszMerchantCity);
char* dpaymentssdk_tsyssettle_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);
char* dpaymentssdk_tsyssettle_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);
char* dpaymentssdk_tsyssettle_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);
char* dpaymentssdk_tsyssettle_getmerchantname(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantname(void* lpObj, const char* lpszMerchantName);
char* dpaymentssdk_tsyssettle_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);
char* dpaymentssdk_tsyssettle_getmerchantphone(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);
char* dpaymentssdk_tsyssettle_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);
char* dpaymentssdk_tsyssettle_getmerchantstate(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantstate(void* lpObj, const char* lpszMerchantState);
char* dpaymentssdk_tsyssettle_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);
char* dpaymentssdk_tsyssettle_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);
char* dpaymentssdk_tsyssettle_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);
char* dpaymentssdk_tsyssettle_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);
char* dpaymentssdk_tsyssettle_getmerchantzip(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantzip(void* lpObj, const char* lpszMerchantZip);
QString GetMerchantBankId();
int SetMerchantBankId(QString qsMerchantBankId); QString GetMerchantCategoryCode();
int SetMerchantCategoryCode(QString qsMerchantCategoryCode); QString GetMerchantCity();
int SetMerchantCity(QString qsMerchantCity); QString GetMerchantCountryCode();
int SetMerchantCountryCode(QString qsMerchantCountryCode); QString GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(QString qsMerchantCurrencyCode); QString GetMerchantLanguage();
int SetMerchantLanguage(QString qsMerchantLanguage); QString GetMerchantName();
int SetMerchantName(QString qsMerchantName); QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber); QString GetMerchantPhone();
int SetMerchantPhone(QString qsMerchantPhone); QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone); QString GetMerchantState();
int SetMerchantState(QString qsMerchantState); QString GetMerchantStoreNumber();
int SetMerchantStoreNumber(QString qsMerchantStoreNumber); QString GetMerchantStreetAddress();
int SetMerchantStreetAddress(QString qsMerchantStreetAddress); QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber); QString GetMerchantTimeZone();
int SetMerchantTimeZone(QString qsMerchantTimeZone); QString GetMerchantZip();
int SetMerchantZip(QString qsMerchantZip);
Remarks
This property must be set to an instance of the TSYSMerchant type, which will contain information to identify the merchant to the TSYS processing server. Please see the TSYSMerchant type for a list of available fields.
Data Type
MerchantLocalPhone Property (TSYSSettle Class)
Merchant's local phone number. Used in settlement only.
Syntax
ANSI (Cross Platform) char* GetMerchantLocalPhone();
int SetMerchantLocalPhone(const char* lpszMerchantLocalPhone); Unicode (Windows) LPWSTR GetMerchantLocalPhone();
INT SetMerchantLocalPhone(LPCWSTR lpszMerchantLocalPhone);
char* dpaymentssdk_tsyssettle_getmerchantlocalphone(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantlocalphone(void* lpObj, const char* lpszMerchantLocalPhone);
QString GetMerchantLocalPhone();
int SetMerchantLocalPhone(QString qsMerchantLocalPhone);
Default Value
""
Remarks
This property should contain an 11-character merchant 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 phone number should be the number for the local merchant establishment. For the Hotel IndustryType, it should contain the phone number for the actual hotel at which the customer is staying. Likewise, for the Auto Rental IndustryType this property must contain the phone number for the location from which the car is actually rented.
This property is used for Hotel, Auto Rental, and Direct Marketing IndustryTypes.
This field is only used in the settlement, and will be ignored for all authorizations.
Data Type
String
Response Property (TSYSSettle Class)
Contains the response to a batch settlement.
Syntax
DPaymentsSDKTSYSSettleResponse* GetResponse();
char* dpaymentssdk_tsyssettle_getresponsecode(void* lpObj);
char* dpaymentssdk_tsyssettle_getresponsenetdeposit(void* lpObj);
int dpaymentssdk_tsyssettle_getresponsenumber(void* lpObj);
int dpaymentssdk_tsyssettle_getresponserecordcount(void* lpObj);
char* dpaymentssdk_tsyssettle_getresponsetext(void* lpObj);
char* dpaymentssdk_tsyssettle_getresponsetransmissiondate(void* lpObj);
QString GetResponseCode(); QString GetResponseNetDeposit(); int GetResponseNumber(); int GetResponseRecordCount(); QString GetResponseText(); QString GetResponseTransmissionDate();
Remarks
This property will contain the response returned from the TSYS transaction server after calling SendSettlement. This property should be inspected (and logged) after a settlement. The TSYSSettleResponse type contains the following fields:
| Code | Indicates the status of the batch transmission. |
| NetDeposit | Total of purchases minus credits and voids. |
| Number | Batch number that belongs to this response. |
| RecordCount | Number of records received by the server for this batch. |
| Text | Textual description of the Code. |
| TransmissionDate | Date that the batch was settled. |
This property is read-only.
Data Type
DPaymentsSDKTSYSSettleResponse
SSLAcceptServerCert Property (TSYSSettle Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
DPaymentsSDKCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);
char* dpaymentssdk_tsyssettle_getsslacceptservercerteffectivedate(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertexpirationdate(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertextendedkeyusage(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertfingerprint(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertfingerprintsha1(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertfingerprintsha256(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertissuer(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertprivatekey(void* lpObj);
int dpaymentssdk_tsyssettle_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertpublickey(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int dpaymentssdk_tsyssettle_getsslacceptservercertpublickeylength(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertserialnumber(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertsignaturealgorithm(void* lpObj);
int dpaymentssdk_tsyssettle_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_tsyssettle_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* dpaymentssdk_tsyssettle_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_tsyssettle_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int dpaymentssdk_tsyssettle_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_tsyssettle_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* dpaymentssdk_tsyssettle_getsslacceptservercertsubjectaltnames(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertthumbprintmd5(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertthumbprintsha1(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertthumbprintsha256(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertusage(void* lpObj);
int dpaymentssdk_tsyssettle_getsslacceptservercertusageflags(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertversion(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_tsyssettle_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int dpaymentssdk_tsyssettle_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsyssettle_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString GetSSLAcceptServerCertEffectiveDate(); QString GetSSLAcceptServerCertExpirationDate(); QString GetSSLAcceptServerCertExtendedKeyUsage(); QString GetSSLAcceptServerCertFingerprint(); QString GetSSLAcceptServerCertFingerprintSHA1(); QString GetSSLAcceptServerCertFingerprintSHA256(); QString GetSSLAcceptServerCertIssuer(); QString GetSSLAcceptServerCertPrivateKey(); bool GetSSLAcceptServerCertPrivateKeyAvailable(); QString GetSSLAcceptServerCertPrivateKeyContainer(); QString GetSSLAcceptServerCertPublicKey(); QString GetSSLAcceptServerCertPublicKeyAlgorithm(); int GetSSLAcceptServerCertPublicKeyLength(); QString GetSSLAcceptServerCertSerialNumber(); QString GetSSLAcceptServerCertSignatureAlgorithm(); QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString GetSSLAcceptServerCertSubjectAltNames(); QString GetSSLAcceptServerCertThumbprintMD5(); QString GetSSLAcceptServerCertThumbprintSHA1(); QString GetSSLAcceptServerCertThumbprintSHA256(); QString GetSSLAcceptServerCertUsage(); int GetSSLAcceptServerCertUsageFlags(); QString GetSSLAcceptServerCertVersion(); QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Data Type
SSLCert Property (TSYSSettle Class)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
DPaymentsSDKCertificate* GetSSLCert(); int SetSSLCert(DPaymentsSDKCertificate* val);
char* dpaymentssdk_tsyssettle_getsslcerteffectivedate(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertexpirationdate(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertextendedkeyusage(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertfingerprint(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertfingerprintsha1(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertfingerprintsha256(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertissuer(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertprivatekey(void* lpObj);
int dpaymentssdk_tsyssettle_getsslcertprivatekeyavailable(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertprivatekeycontainer(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertpublickey(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertpublickeyalgorithm(void* lpObj);
int dpaymentssdk_tsyssettle_getsslcertpublickeylength(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertserialnumber(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertsignaturealgorithm(void* lpObj);
int dpaymentssdk_tsyssettle_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsyssettle_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* dpaymentssdk_tsyssettle_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsyssettle_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int dpaymentssdk_tsyssettle_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsyssettle_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* dpaymentssdk_tsyssettle_getsslcertsubjectaltnames(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertthumbprintmd5(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertthumbprintsha1(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertthumbprintsha256(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertusage(void* lpObj);
int dpaymentssdk_tsyssettle_getsslcertusageflags(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertversion(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsyssettle_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int dpaymentssdk_tsyssettle_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsyssettle_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString GetSSLCertEffectiveDate(); QString GetSSLCertExpirationDate(); QString GetSSLCertExtendedKeyUsage(); QString GetSSLCertFingerprint(); QString GetSSLCertFingerprintSHA1(); QString GetSSLCertFingerprintSHA256(); QString GetSSLCertIssuer(); QString GetSSLCertPrivateKey(); bool GetSSLCertPrivateKeyAvailable(); QString GetSSLCertPrivateKeyContainer(); QString GetSSLCertPublicKey(); QString GetSSLCertPublicKeyAlgorithm(); int GetSSLCertPublicKeyLength(); QString GetSSLCertSerialNumber(); QString GetSSLCertSignatureAlgorithm(); QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore); QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword); int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); QString GetSSLCertSubjectAltNames(); QString GetSSLCertThumbprintMD5(); QString GetSSLCertThumbprintSHA1(); QString GetSSLCertThumbprintSHA256(); QString GetSSLCertUsage(); int GetSSLCertUsageFlags(); QString GetSSLCertVersion(); QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject); QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Data Type
SSLProvider Property (TSYSSettle Class)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int dpaymentssdk_tsyssettle_getsslprovider(void* lpObj);
int dpaymentssdk_tsyssettle_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 as follows:
| 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
SSLServerCert Property (TSYSSettle Class)
The server certificate for the last established connection.
Syntax
DPaymentsSDKCertificate* GetSSLServerCert();
char* dpaymentssdk_tsyssettle_getsslservercerteffectivedate(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertexpirationdate(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertextendedkeyusage(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertfingerprint(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertfingerprintsha1(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertfingerprintsha256(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertissuer(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertprivatekey(void* lpObj);
int dpaymentssdk_tsyssettle_getsslservercertprivatekeyavailable(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertprivatekeycontainer(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertpublickey(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertpublickeyalgorithm(void* lpObj);
int dpaymentssdk_tsyssettle_getsslservercertpublickeylength(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertserialnumber(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertsignaturealgorithm(void* lpObj);
int dpaymentssdk_tsyssettle_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* dpaymentssdk_tsyssettle_getsslservercertstorepassword(void* lpObj);
int dpaymentssdk_tsyssettle_getsslservercertstoretype(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertsubjectaltnames(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertthumbprintmd5(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertthumbprintsha1(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertthumbprintsha256(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertusage(void* lpObj);
int dpaymentssdk_tsyssettle_getsslservercertusageflags(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertversion(void* lpObj);
char* dpaymentssdk_tsyssettle_getsslservercertsubject(void* lpObj);
int dpaymentssdk_tsyssettle_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString GetSSLServerCertEffectiveDate(); QString GetSSLServerCertExpirationDate(); QString GetSSLServerCertExtendedKeyUsage(); QString GetSSLServerCertFingerprint(); QString GetSSLServerCertFingerprintSHA1(); QString GetSSLServerCertFingerprintSHA256(); QString GetSSLServerCertIssuer(); QString GetSSLServerCertPrivateKey(); bool GetSSLServerCertPrivateKeyAvailable(); QString GetSSLServerCertPrivateKeyContainer(); QString GetSSLServerCertPublicKey(); QString GetSSLServerCertPublicKeyAlgorithm(); int GetSSLServerCertPublicKeyLength(); QString GetSSLServerCertSerialNumber(); QString GetSSLServerCertSignatureAlgorithm(); QByteArray GetSSLServerCertStore(); QString GetSSLServerCertStorePassword(); int GetSSLServerCertStoreType(); QString GetSSLServerCertSubjectAltNames(); QString GetSSLServerCertThumbprintMD5(); QString GetSSLServerCertThumbprintSHA1(); QString GetSSLServerCertThumbprintSHA256(); QString GetSSLServerCertUsage(); int GetSSLServerCertUsageFlags(); QString GetSSLServerCertVersion(); QString GetSSLServerCertSubject(); QByteArray GetSSLServerCertEncoded();
Remarks
This property contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Data Type
TerminalId Property (TSYSSettle Class)
Contains number to accommodate a POS device tracking number.
Syntax
ANSI (Cross Platform) char* GetTerminalId();
int SetTerminalId(const char* lpszTerminalId); Unicode (Windows) LPWSTR GetTerminalId();
INT SetTerminalId(LPCWSTR lpszTerminalId);
char* dpaymentssdk_tsyssettle_getterminalid(void* lpObj);
int dpaymentssdk_tsyssettle_setterminalid(void* lpObj, const char* lpszTerminalId);
QString GetTerminalId();
int SetTerminalId(QString qsTerminalId);
Default Value
"00000001"
Remarks
This eight digit field contains the number to accommodate a Point Of Sale (POS) device tracking number. This field is also known as the "V" number. Unless otherwise specified by the merchant's bank or processor, this field should be defaulted to "00000001".
Note: If specified, the "V" alpha character must be changed to a numeric 7 when setting this property.
This is a Parameter Property, and need only be set once for a single Batch Settlement transaction.
Data Type
String
Timeout Property (TSYSSettle 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_tsyssettle_gettimeout(void* lpObj);
int dpaymentssdk_tsyssettle_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
Config Method (TSYSSettle Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* dpaymentssdk_tsyssettle_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.
Interrupt Method (TSYSSettle Class)
Interrupts the current action.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int dpaymentssdk_tsyssettle_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 (TSYSSettle Class)
Resets all the properties of the entire settlement to their default values.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int dpaymentssdk_tsyssettle_reset(void* lpObj);
int Reset();
Remarks
This method resets the Header and Parameter Record properties to default values, and clears all Detail Records. To clear only the Detail Records (leaving Header and Parameter records intact) set the DetailRecordCount property to 0.
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.)
SendSettlement Method (TSYSSettle Class)
Begins a Batch Settlement transaction with the transaction server.
Syntax
ANSI (Cross Platform) int SendSettlement(); Unicode (Windows) INT SendSettlement();
int dpaymentssdk_tsyssettle_sendsettlement(void* lpObj);
int SendSettlement();
Remarks
This begins a Batch Settlement transaction. The Header Record, Parameter Record, all transaction Detail Records, and the computed Trailer Record are sent sequentially to the Vital/TSYS host.
If the transaction is successful, the Code will contain "GB", which indicates a "Good Batch". You should check that the NetDeposit and RecordCount match the NetDeposit and RecordCount fields.
If the transaction is not successful and you receive an "RB" Code (indicating a "Rejected Batch") the class fails with an error. You may inspect the Data. DataFieldNumber, RecordType, SequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.
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 (TSYSSettle Class)
Fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(TSYSSettleConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } TSYSSettleConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(TSYSSettleConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } TSYSSettleConnectedEventParams;
#define EID_TSYSSETTLE_CONNECTED 1 virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
class TSYSSettleConnectedEventParams {
public:
int StatusCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Connected(TSYSSettleConnectedEventParams *e);
// Or, subclass TSYSSettle and override this emitter function.
virtual int FireConnected(TSYSSettleConnectedEventParams *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 (TSYSSettle Class)
Fired when receiving a data packet from the transaction server.
Syntax
ANSI (Cross Platform) virtual int FireDataPacketIn(TSYSSettleDataPacketInEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } TSYSSettleDataPacketInEventParams;
Unicode (Windows) virtual INT FireDataPacketIn(TSYSSettleDataPacketInEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } TSYSSettleDataPacketInEventParams;
#define EID_TSYSSETTLE_DATAPACKETIN 2 virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);
class TSYSSettleDataPacketInEventParams {
public:
const QByteArray &DataPacket();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void DataPacketIn(TSYSSettleDataPacketInEventParams *e);
// Or, subclass TSYSSettle and override this emitter function.
virtual int FireDataPacketIn(TSYSSettleDataPacketInEventParams *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 (TSYSSettle Class)
Fired when sending a data packet to the transaction server.
Syntax
ANSI (Cross Platform) virtual int FireDataPacketOut(TSYSSettleDataPacketOutEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } TSYSSettleDataPacketOutEventParams;
Unicode (Windows) virtual INT FireDataPacketOut(TSYSSettleDataPacketOutEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } TSYSSettleDataPacketOutEventParams;
#define EID_TSYSSETTLE_DATAPACKETOUT 3 virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);
class TSYSSettleDataPacketOutEventParams {
public:
const QByteArray &DataPacket();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void DataPacketOut(TSYSSettleDataPacketOutEventParams *e);
// Or, subclass TSYSSettle and override this emitter function.
virtual int FireDataPacketOut(TSYSSettleDataPacketOutEventParams *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 (TSYSSettle Class)
Fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(TSYSSettleDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } TSYSSettleDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(TSYSSettleDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } TSYSSettleDisconnectedEventParams;
#define EID_TSYSSETTLE_DISCONNECTED 4 virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
class TSYSSettleDisconnectedEventParams {
public:
int StatusCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Disconnected(TSYSSettleDisconnectedEventParams *e);
// Or, subclass TSYSSettle and override this emitter function.
virtual int FireDisconnected(TSYSSettleDisconnectedEventParams *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 (TSYSSettle Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(TSYSSettleErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } TSYSSettleErrorEventParams;
Unicode (Windows) virtual INT FireError(TSYSSettleErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } TSYSSettleErrorEventParams;
#define EID_TSYSSETTLE_ERROR 5 virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class TSYSSettleErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(TSYSSettleErrorEventParams *e);
// Or, subclass TSYSSettle and override this emitter function.
virtual int FireError(TSYSSettleErrorEventParams *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 (TSYSSettle Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(TSYSSettleSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } TSYSSettleSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(TSYSSettleSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } TSYSSettleSSLServerAuthenticationEventParams;
#define EID_TSYSSETTLE_SSLSERVERAUTHENTICATION 6 virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class TSYSSettleSSLServerAuthenticationEventParams {
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(TSYSSettleSSLServerAuthenticationEventParams *e);
// Or, subclass TSYSSettle and override this emitter function.
virtual int FireSSLServerAuthentication(TSYSSettleSSLServerAuthenticationEventParams *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 (TSYSSettle Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(TSYSSettleSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } TSYSSettleSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(TSYSSettleSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } TSYSSettleSSLStatusEventParams;
#define EID_TSYSSETTLE_SSLSTATUS 7 virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);
class TSYSSettleSSLStatusEventParams {
public:
const QString &Message();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void SSLStatus(TSYSSettleSSLStatusEventParams *e);
// Or, subclass TSYSSettle and override this emitter function.
virtual int FireSSLStatus(TSYSSettleSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Certificate Type
This is the digital certificate being used.
Syntax
DPaymentsSDKCertificate (declared in dpaymentssdk.h)
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
- EffectiveDate
- ExpirationDate
- ExtendedKeyUsage
- Fingerprint
- FingerprintSHA1
- FingerprintSHA256
- Issuer
- PrivateKey
- PrivateKeyAvailable
- PrivateKeyContainer
- PublicKey
- PublicKeyAlgorithm
- PublicKeyLength
- SerialNumber
- SignatureAlgorithm
- Store
- StorePassword
- StoreType
- SubjectAltNames
- ThumbprintMD5
- ThumbprintSHA1
- ThumbprintSHA256
- Usage
- UsageFlags
- Version
- Subject
- Encoded
Fields
EffectiveDate
char* (read-only)
Default Value: ""
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
char* (read-only)
Default Value: ""
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
char* (read-only)
Default Value: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
char* (read-only)
Default Value: ""
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
char* (read-only)
Default Value: ""
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
char* (read-only)
Default Value: ""
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
char* (read-only)
Default Value: ""
The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
char* (read-only)
Default Value: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
int (read-only)
Default Value: FALSE
Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
char* (read-only)
Default Value: ""
The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
char* (read-only)
Default Value: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
char* (read-only)
Default Value: ""
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
char*
Default Value: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
char*
Default Value: ""
If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
The type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
char* (read-only)
Default Value: ""
Comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
char* (read-only)
Default Value: ""
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
char* (read-only)
Default Value: ""
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
char* (read-only)
Default Value: ""
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
char* (read-only)
Default Value: ""
The text description of UsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
char* (read-only)
Default Value: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
char*
Default Value: ""
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the field is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
char*
Default Value: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
Certificate()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
Certificate(const char* lpEncoded, int lenEncoded)
Parses Encoded as an X.509 public key.
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
TSYSBatchErrorInfo Type
Contains information about settlement errors.
Syntax
DPaymentsSDKTSYSBatchErrorInfo (declared in dpaymentssdk.h)
Remarks
If there is an error in the settlement that results in a rejected batch, this type will contain information that can help you determine what has caused the settlement to fail. The following fields are available:
Fields
Data
char* (read-only)
Default Value: ""
Erroneous data contained within the field specified by DataFieldNumber.
When you receive a Rejected Batch (ResponseCode is "RB"), this 32-character field will contain the data that caused the batch to fail. The record that contains this error is specified by SequenceNumber, and the location of the erroneous data within that record is specified by DataFieldNumber.
DataFieldNumber
int (read-only)
Default Value: 0
Field within an invalid record that contains an error.
When you receive a Rejected Batch (ResponseCode is "RB"), this field contains the sequential field number within the data record which caused the batch to be rejected. The erroneous data within this field is returned in Data, and the sequence number of the record that contains this error is specified by SequenceNumber.
DetailRecordIndex
int (read-only)
Default Value: -1
Provides the index of the DetailRecord that caused the batch error.
When you receive a Rejected Batch (Response Code of 'RB'), this field will be populated with the index of the DetailRecord that caused the error (provided that it was a Detail Record that caused it). If no error occurred, this field will return "-1".
ErrorType
char* (read-only)
Default Value: ""
Type of batch error.
When you receive a Rejected Batch (ResponseCode is "RB"), this one character field will provide additional info as to the nature of the rejected batch. The following table lists the currently defined error types.
| B | Blocked terminal. |
| C | Card type error. |
| D | Device error. |
| E | Error in Batch. |
| S | Sequence error. |
| T | Transmission error. |
| U | Unknown error. |
| V | Routing error. |
RecordType
char* (read-only)
Default Value: ""
Type of record in which an error occurred.
When you receive a Rejected Batch (ResponseCode is "RB"), this one character field defines the type of data record which caused the batch to be rejected. The table below lists all valid responses.
| H | Header Record. |
| P | Parameter Record. |
| D | Detail Record. |
| L | Line Item Detail Record. |
| T | Trailer Record. |
SequenceNumber
int (read-only)
Default Value: 0
Sequence number of the record that caused an error.
When you receive a Rejected Batch (ResponseCode is "RB"), this field will contain the sequential number of the data record which caused the rejected batch state. To obtain the index of the DetailRecord in the DetailRecords arrays that contains the erroneous data, please see the DetailRecordIndex. The field within this record that contains erroneous data is specified by DataFieldNumber, and the actual data causing the error will be contained in the Data field.
Constructors
TSYSBatchErrorInfo()
TSYSBatchInfo Type
Contains information about the batch settlement as computed by the component.
Syntax
DPaymentsSDKTSYSBatchInfo (declared in dpaymentssdk.h)
Remarks
When building a settlement, the class will calculate the fields listed below:
Fields
CashBackTotal
char* (read-only)
Default Value: "0000000000000000"
Total amount of cash back for all transactions in the batch.
This field contains the total of all cash back amounts reflected in the settlement batch. Note that only Debit Cards, Gift Cards, and EBT cards allow for cash back to be returned to the customer. For normal credit card transactions, this field will be defaulted to zeros.
This is a Trailer field, and is automatically computed by the class.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
HashingTotal
char* (read-only)
Default Value: "0000000000000000"
Total of purchases plus credits.
This 16-digit field contains the batch hashing total generated by the terminal. The hashing total is generated by adding the absolute value of all detail record amounts. Void and purchase return settlement amounts are treated as positive and added to the total, not subtracted from it.
This is a Trailer field, and is automatically computed by the class.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
NetDeposit
char* (read-only)
Default Value: "0000000000000000"
Total of purchases minus credits.
This 16-digit field contains the net deposit generated by the terminal. The net deposit total is generated by adding the settlement amounts of all detail transaction records and subtracting credit/refund amounts from it.
This is a Trailer field, and is automatically computed by the class.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
RecordCount
int (read-only)
Default Value: 0
Total number of records sent including Header, Parameter, and Trailer.
This field contains a batch (transaction) record count, calculated by the class. This field is supplied in the Batch Trailer Record and contains the total number of transactions in the batch -- including Header, Parameter, Detail(s), and Trailer records. This field reflects the actual number of records that have been sent, and is independent of the number of detail records sent in the settlement.
This is a Trailer field, and is automatically computed by the class.
Constructors
TSYSBatchInfo()
TSYSMerchant Type
Contains the merchant's setup information.
Syntax
DPaymentsSDKTSYSMerchant (declared in dpaymentssdk.h)
Remarks
This type contains the merchant's setup information. This includes the merchant identification, bank routing information, language, location, and other fields that identify the merchant to the TSYS server. Some of the information in these fields will be included on the customer's credit card statement, such as the merchant's Name, State, ServicePhone, etc.
- BankId
- CategoryCode
- City
- CountryCode
- CurrencyCode
- Language
- Name
- Number
- Phone
- ServicePhone
- State
- StoreNumber
- StreetAddress
- TerminalNumber
- TimeZone
- Zip
Fields
BankId
char*
Default Value: ""
The number which identifies the merchant's bank or processor.
This field contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This field may not remain zero-filled.
Note, the TSYS Server uses the Merchant's BankId and Number to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
CategoryCode
char*
Default Value: ""
Classifies a merchant by the type of store.
This four digit field contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
City
char*
Default Value: ""
Merchant's City
For Retail (Card Present) transactions, this field should contain the city in which the merchant is located. This is an optional field. However if it is specified, the Name and State must also be specified.
Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this field is ignored. ServicePhone is used for those industries instead of City (this does not apply to MasterCard).
Note: This field must contain the same data used in the batch settlement. The first character of this field may not be a space. This field may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this field is 13 characters.
CountryCode
char*
Default Value: "840"
Identifies the country where the merchant is located.
This field contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".
CurrencyCode
char*
Default Value: "840"
Identifies the type of currency used by the merchant.
This field contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".
Language
char*
Default Value: "00"
Designates the language that response messages will be returned in.
This field contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This field may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.
| Indicator | Language |
| 00 | English. |
| 01 | Spanish. |
| 02 | Portuguese. |
| 03 | Reserved for Irish. |
| 04 | Reserved for French. |
| 05 | Reserved for German. |
| 06 | Reserved for Italian. |
| 07 | Reserved for Dutch. |
Name
char*
Default Value: ""
Name of the merchant.
This 25 character field contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this field may not be a space. This field must contain the same value in both authorization and batch settlement.
This is an optional field. However if this field is specified, the State and City (Retail) or State and ServicePhone (E-Commerce) must also be specified.
This field may contain alphanumeric and punctuation characters. The maximum length of this field is 25 characters.
Number
char*
Default Value: ""
A unique number used to identify the merchant within the VisaNet system.
This 12 digit field contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.
Note, the TSYS Server uses the Merchant's BankId and Number to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
Phone
char*
Default Value: ""
Merchant's phone number.
This field contains the Merchant's business phone number. This can be the same as the customer service phone number.
ServicePhone
char*
Default Value: ""
Merchant's customer service number.
This field contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.
This field is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.
State
char*
Default Value: ""
State or province that the merchant is located in.
This two character field contains the merchant state or province provided by the signing member or processor. This field must contain the same data used in the batch settlement.
This is an optional field. However if it is specified the Merchant Name and City (Retail) or Name and ServicePhone (E-Commerce) must also be specified.
StoreNumber
char*
Default Value: ""
Used to identify a specific merchant's store within the VisaNet system.
This four digit field contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This field must be right-justified and zero-filled.
StreetAddress
char*
Default Value: ""
Merchant's street address.
This 25 character field contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.
TerminalNumber
char*
Default Value: ""
Used to identify a unique terminal within a merchant location.
This four digit field contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This field must be right-justified and zero-filled.
TimeZone
char*
Default Value: "705"
Specifies the GMT offset used to calculate the local time within the VisaNet system.
This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.
Byte #1:
| Value | Meaning |
| 0 | Positive offset, in hours, ahead of GMT. |
| 1 | Negative offset, in hours, behind GMT. |
| 2 | Positive offset, in 15 minute increments, ahead of GMT. |
| 3 | Negative offset, in 15 minute increments, behind GMT. |
| 4 | Positive offset, in 15 minute increments, ahead of GMT, in cities participating in daylight savings. |
| 5 | Negative offset, in 15 minute increments, behind GMT, in cities participating in daylight savings. |
| 6 | Positive offset, in hours, ahead of GMT, in cities participating in daylight savings. |
| 7 | Negative offset, in hours, behind GMT, in cities participating in daylight savings. |
| 8-9 | RESERVED. |
If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.
Zip
char*
Default Value: ""
Zip code where the merchant that initiated this transaction is located.
This field contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this field will be assigned by the signing member or processor.
This field is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the field is set.
Constructors
TSYSMerchant()
TSYSRecordType Type
Detail record storage type.
Syntax
DPaymentsSDKTSYSRecordType (declared in dpaymentssdk.h)
Remarks
This type contains the XML aggregate for a single transaction, as well as an XML aggregate of any additional addenda to be added to the record at settlement. The fields contained by this type are listed below.
Fields
AddendumAggregate
char*
Default Value: ""
Optional Detail Record Addendum data (such as Level2 or Level3 data)
The DetailAggregate field contains an xml aggregate of the transaction retrieved from the TSYSECommerce, TSYSRetail, or TSYSDetailRecord class's GetDetailAggregate method. If you wish to accept corporate purchasing cards you will also need to send Level2, and possibly Level3 addendum data along with the DetailAggregate. The AddendumAggregate field takes an xml aggregate containing either Level2 or Level3 addendum data, which will be added to the DetailAggregate. The addendum aggregate may be created with either the TSYSLevel2 or TSYSLevel3 classs, and then returned via those class's GetAddendum method.
For example:
'First authorize the credit card
TSYSECommerce1.TransactionAmount = "53"
TSYSECommerce.Authorize()
'Then, put the result into the settlement component
TSYSSettle.DetailRecordCount = 1
TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate()
'Now build the Level3 Extension.
'The following properties are required for a Visa Corporate Purchasing Card:
TSYSLevel3.CardType = tctVisa
TSYSLevel3.LocalTax = "EXEMPT"
TSYSLevel3.NationalTax = "0"
TSYSLevel3.PurchaseOrder = "purchOrdNum"
TSYSLevel3.MerchantTaxId = "merchantTaxId" 'Merchant VAT Registration Number
TSYSLevel3.CustomerTaxId = "customerTaxId" 'Customer VAT Registration Number
TSYSLevel3.CommodityCode = "fake"
TSYSLevel3.DiscountAmount = "0"
TSYSLevel3.FreightAmount = "0"
TSYSLevel3.DutyAmount = "0"
TSYSLevel3.DestinationZip = "27709"
TSYSLevel3.ShipFromZip = "27709"
TSYSLevel3.DestinationCountry = "840"
TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo"
TSYSLevel3.OrderDate = "060526"
TSYSLevel3.FreightTaxAmount = "0"
TSYSLevel3.FreightTaxRate = "0"
'Begin adding line items:
TSYSLevel3.LineItemCount = 2
TSYSLevel3.LineItemCommodityCode(0) = "fake"
TSYSLevel3.LineItemDescription(0) = "hardware"
TSYSLevel3.LineItemProductCode(0) = "productCode123"
TSYSLevel3.LineItemQuantity(0) = 1
TSYSLevel3.LineItemUnits(0) = ""
TSYSLevel3.LineItemUnitCost(0) = "33"
TSYSLevel3.LineItemTaxAmount(0) = "0"
TSYSLevel3.LineItemTaxRate(0) = "0"
TSYSLevel3.LineItemDiscountAmount(0) = "0"
TSYSLevel3.LineItemTotal(0) = "33"
TSYSLevel3.LineItemCommodityCode(1) = "fake"
TSYSLevel3.LineItemDescription(1) = "hardware"
TSYSLevel3.LineItemProductCode(1) = "productCode124"
TSYSLevel3.LineItemQuantity(1) = 1
TSYSLevel3.LineItemUnits(1) = ""
TSYSLevel3.LineItemUnitCost(1) = "20"
TSYSLevel3.LineItemTaxAmount(1) = "0"
TSYSLevel3.LineItemTaxRate(1) = "0"
TSYSLevel3.LineItemDiscountAmount(1) = "0"
TSYSLevel3.LineItemTotal(1) = "20"
'Finally, add the Level3 addendum to the same index in the settlement.
TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.GetAddendum()Note that you may mix corporate and non-corporate card transactions in the same settlement. It is not necessary that all DetailAggregates have a corresponding AddendumAggregate.
DetailAggregate
char*
Default Value: ""
Set this field with xml aggregates of the transactions you wish to settle.
To settle previously authorized transactions, this field must be set with the xml aggregate returned from the TSYSRetail, or TSYSECommerce class's GetDetailAggregate method. For instance:
TSYSSettle.DetailRecordCount = 1
TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()On occasion, you may need to modify these aggregates before sending them to settlement. For instance, if you're running a restaurant you may need to add a gratuity to the charge. If you're accepting installment payments, you will need to add the installment info. To accomplish this, you may use the TSYSDetailRecord class.
For example, to add a gratuity to a charge:
DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate())
DetailRecord.Gratuity = "500"
DetailRecord.SettlementAmount = DetailRecord.AuthorizedAmount + DetailRecord.Gratuity
TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()To settle a Passenger Transport transaction authorized with the sitPassengerTransport IndustryType, you must use the TSYSDetailRecord class to add the number of this passenger and the total count of all passengers in the authorization code. For instance, if the authorization transaction included "Three passengers", and this is the first passenger, then the passenger number will be 1, and the passenger count 3. An example is included below:
TSYSRetail.IndustryType = sitPassengerTransport
TSYSRetail.Authorize()
DetailRecord.ParseAggregate TSYSRetail.GetDetailAggregate()
DetailRecord.PassengerCount = 3
DetailRecord.PassengerNumber = 1
DetailRecord.Config("RestrictedTicketIndicator=True")
DetailRecord.Config("TicketNumber=8382152100395")
DetailRecord.Config("PassengerName=John Smith")
DetailRecord.Config("DepartureDate=072117")
DetailRecord.Config("Origin=JFK")
DetailRecord.Config("Leg1=Carrier=DL;ServiceClass=C;StopOver=X;Destination=LAX")
TSYSSettle1.IndustryType = sitPassengerTransport
TSYSSettle1.Config("TravelAgencyCode=12345678") 'if ticket was issued by a travel agency
TSYSSettle1.Config("TravelAgencyName=Travel and Tours") 'if ticket was issued by a travel agency
TSYSSettle1.DetailAggregate[5] = DetailRecord.GetDetailAggregate()Constructors
TSYSRecordType()
TSYSRecordType(const char* lpszDetailAggregate)
TSYSRecordType(const char* lpszDetailAggregate, const char* lpszAddendumAggregate)
TSYSSettleResponse Type
Contains the response to a batch settlement.
Syntax
DPaymentsSDKTSYSSettleResponse (declared in dpaymentssdk.h)
Remarks
This type contains the results of a batch settlement made with the TSYSSettle class. The fields contained by this type are listed below.
Fields
Code
char* (read-only)
Default Value: ""
Indicates the status of the batch transmission.
This field contains the two character response code returned by the host indicating the status of the Batch Settlement attempt. The following table provides a summary of the response returned by the TSYS host:
| GB | Good Batch. |
| QD | Duplicate Batch. |
| RB | Rejected Batch. |
NetDeposit
char* (read-only)
Default Value: ""
Total of purchases minus credits and voids.
This field contains the net deposit generated by the terminal. It should equal the BatchNetDesposit field, which is computed by the class. The net deposit total is generated by adding the settlement amounts of all detail transaction records and subtracting credit amounts from it. This field is represented as an absolute value and cannot be negative.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
Number
int (read-only)
Default Value: 0
Batch number that belongs to this response.
This field should be compared to the BatchNumber in order to match a response with a given Batch Settlement. If running in synchronous mode, this field should always be identical to BatchNumber.
RecordCount
int (read-only)
Default Value: 0
Number of records received by the server in this batch.
This field contains the total number of records received by the host -- including Header, Parameter, Detail, and Trailer records. In the case of a Code of "GB" (Good Batch), the value returned should match the value in the Batch.RecordCount field. In the case of a Code of "RB" (Rejected Batch), this field will reflect the total number of records received until the point of failure. RecordCount + 1 will reveal the sequential number of the transaction record responsible for causing a rejected batch condition, and should be identical to the Error.SequenceNumber field in this case.
Text
char* (read-only)
Default Value: ""
Contents of this field are dependent upon the Code.
This nine character field will contain the text "_ACCEPTED" when a settlement batch has been successfully received by the host. However, the Point of Sale (POS) device should examine only the Code to determine the status of a particular Batch Settlement.
TransmissionDate
char* (read-only)
Default Value: ""
Date that the batch was settled.
This field is reserved, pending the future upgrade to a higher protocol version.
Constructors
TSYSSettleResponse()
DPaymentsSDKList Type
Syntax
DPaymentsSDKList<T> (declared in dpaymentssdk.h)
Remarks
DPaymentsSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the TSYSSettle class.
Config Settings (TSYSSettle 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.TSYSSettle Config Settings
This configuration setting is used for Amex OptBlue participators to determine the name of the Payment Service Provider, Aggragator or Facilitator. You need to set this field for transactions originating from an Aggregator, Payment Service Provider or Facilitator. The maximum length of this field is 12-characters and it must not contain spaces.
Default value of this configuration setting is True meaning that settlement records will be combined together to optimize message size and expedite the overall settlement process by minimizing the total number of settlement packets to be transmitted. Setting this to False will send each record as a separate settlement packet during the batch settlement process.
This configuration setting contains a 1-character value used to identify the device and type of the merchant submitting the settlement batch. The table below provides a summary of currently defined values. The default value for this setting is "Q".
| 0 | Unknown or unsure. |
| B | Automated Teller Machine (ATM). |
| C | Personal Computer (PC) |
| D | Dial terminal |
| E | Electronic Cash Register (ECR) |
| G | Mobile Payment Acceptance. |
| H | TSYS Hosted Payment. |
| I | In-store processor |
| J | Multi Payment Acceptance. |
| M | Mainframe |
| P | POS-Port |
| Q | Third-party developer |
| R | POS-Port |
| S | POS Partner |
| T | Counter Payment Acceptance. |
| W | Web Payment Acceptance. |
| X | EMV Mode Contact and/or Contactless terminal (Must be used on all EMV mode chip card transactions). |
| Z | Suppress PS2000/Merit fields |
This field is used to specify retrieve or specify a GenKey value for a terminal. This field will be populated after a successful call to ActivateTerminal is made. The Genkey must be stored in the POS device, must be sent with every request to the TSYS Acquiring Solutions host after authentication (by setting this field), and will be checked against the terminal hierarchy. A GenKey value is required when processing transactions using Voltage Encryption or Tokenization.
The specified value must be 4 characters or less. Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.
This field allows you to specify the Heartland E3 encryption mode used when processing Heartland transactions. The available values are (descriptions describe the data that will be encrypted):
| 0 | No Encryption (default) |
| 1 | Merchant ID and Card Data (reserved for future use) |
| 2 | Merchant ID, Card Data, and Card Security Code (reserved for future use) |
| 3 | Card Data Only |
Note you will also need to set Processor to 1 (Heartland) and HeartlandKeyBlock if you wish to process Heartland E3 transactions.
This field allows you to specify the key block that was used to encrypt the data specified by HeartlandEncryptionMode. This value will be obtained from an E3 magnetic stripe reader and is used by Heartland to decrypt the encrypted data.
This field contains a five character value providing additional information on the location of the merchant. Unless otherwise specified by the merchant's bank or processor, this field should be defaulted to "00001".
This is a Parameter Property, and only needs to be set once for a single Batch Settlement transaction.
This is port that this class connects to on the server. The default value for TSYS is 5003 for the live server, and 5004 for the test server. The default live server values for Heartland is 22341 for Authorization and 22342 for Settlement. The Heartland test server values are 12341 for Authorization and 12342 for Settlement.
This field allows you to specify the processor that you are connecting to (thus allowing the class to correctly generate the request and parse the response). The available values are:
| 0 | TSYS (default) |
| 1 | Heartland |
Note that when set, this property will set the Server and Port to the default values for the specified processor. Additionally, this config must be set prior to setting Card to ensure the card data is formatted correctly.
This is name of the server to which all transactions are posted. Do not use an IP address, use the actual name, as a server's IP address may change. The default (Live) TSYS server is "ssl2.vitalps.net", but you may use "ssltest.tsysacquiring.net" for testing. The default (Live) Heartland server is "txns.secureexchange.net", but you may use "test.txns.secureexchange.net" for testing. Note that there are several BankIds and Numbers that will always run in test mode regardless of whether you are using the live server. See the included demos for examples.
You do not need to set this field if the merchant is not a travel agency. The default value of this field is space-filled.
You do not need to set this field if the merchant is not a travel agency. The default value of this field is space-filled.
Default value of this configuration setting is False meaning that settlement records will be sent using Socket connection. When True, the component will submit the whole batch at once using POST. You must also set Server to the correct end-point for POST transmission.
Note that the maximum batch size that can be transmitted via POST is 2MB.
TCPClient Config Settings
When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.
This configuration setting is provided for use by classs that do not directly expose Firewall properties.
If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
Possible values are as follows:
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS.
When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.
This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.
The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.
This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.example.com
If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.
Note: This value is not applicable in Java.
When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.
By default, this configuration setting is set to False.
When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
This functionality is available only when the provider is OpenSSL.
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
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.
This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting enables the cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");- 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_ECDH_RSA_WITH_AES_128_CBC_SHA");- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
This configuration setting is used to enable or disable the supported security protocols.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.
This configuration setting is applicable only when SSLProvider is set to Internal.
This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
This configuration setting returns the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");This configuration setting returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:
| 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 non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration 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");To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.
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)
This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.
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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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"
This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:
- "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)
This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.
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
If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for User Datagram Protocol (UDP) ports.
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).
This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.
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.
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.
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
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
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 |
When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
- 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.
In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
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.
If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
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 (TSYSSettle 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.
TSYSSettle 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 Number and BankId). |
| 596 | Pending responses max number exceeded (Interleaved). |
| 597 | Pending response timeout (Interleaved). |
| 606 | One or more detail records are empty. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
| 100 | You cannot change the RemotePort at this time. A connection is in progress. |
| 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 102 | The RemoteHost address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the LocalPort at this time. A connection is in progress. |
| 107 | You cannot change the LocalHost at this time. A connection is in progress. |
| 112 | You cannot change MaxLineLength at this time. A connection is in progress. |
| 116 | RemotePort cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the class is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 302 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |
SSL Errors
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |
TCP/IP Errors
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |