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 MerchantTerminalNumber. The MerchantTerminalNumber 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 = itRetail

At this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the DetailRecordAggregate array property. First set the DetailRecordCount; to the total number of transactions you wish to settle. Each index in the DetailRecordAggregate 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 ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the class fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, 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 DetailRecordAggregate 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 DetailRecordAddendum property 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.

AgentBankNumberIdentifies a specific agent entity of the member bank or processor.
AgentChainNumberIdentifies a specific chain of an agent organization.
BatchCashBackTotalTotal amount of cash back for all transactions in the batch.
BatchHashingTotalTotal of purchases plus credits.
BatchNetDepositTotal of purchases minus credits.
BatchRecordCountTotal number of records sent including Header, Parameter, and Trailer.
BatchNumberSequence number of this batch transaction.
DetailRecordCountThe number of records in the DetailRecord arrays.
DetailRecordAddendumOptional Detail Record Addendum data (such as Level2 or Level3 data) The DetailAggregate property contains an xml aggregate of the transaction retrieved from the TSYSECOMMERCE , TSYSRETAIL , or TSYSDETAILRECORD class's GetDetailAggregate method.
DetailRecordAggregateSet this property with xml aggregates of the transactions you wish to settle.
ErrorDataErroneous data contained within the property specified by DataFieldNumber .
ErrorDataFieldNumberField within an invalid record that contains an error.
ErrorDetailRecordIndexProvides the index of the DetailRecord that caused the batch error.
ErrorTypeType of batch error.
ErrorRecordTypeType of record in which an error occurred.
ErrorSequenceNumberSequence number of the record that caused an error.
IndustryTypeCode which indicates the industry the merchant is engaged in.
MerchantBankIdThe number which identifies the merchant's bank or processor.
MerchantCategoryCodeClassifies a merchant by the type of store.
MerchantCityMerchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
MerchantCountryCodeIdentifies the country where the merchant is located.
MerchantCurrencyCodeIdentifies the type of currency used by the merchant.
MerchantLanguageDesignates the language that response messages will be returned in.
MerchantNameName of the merchant.
MerchantNumberA unique number used to identify the merchant within the VisaNet system.
MerchantPhoneMerchant's phone number.
MerchantServicePhoneMerchant's customer service number.
MerchantStateState or province that the merchant is located in.
MerchantStoreNumberUsed to identify a specific merchant's store within the VisaNet system.
MerchantStreetAddressMerchant's street address.
MerchantTerminalNumberUsed to identify a unique terminal within a merchant location.
MerchantTimeZoneSpecifies the GMT offset used to calculate the local time within the VisaNet system.
MerchantZipZip code where the merchant that initiated this transaction is located.
MerchantLocalPhoneMerchant's local phone number. Used in settlement only.
ResponseCodeIndicates the status of the batch transmission.
ResponseNetDepositTotal of purchases minus credits and voids.
ResponseNumberBatch number that belongs to this response.
ResponseRecordCountNumber of records received by the server in this batch.
ResponseTextContents of this property are dependent upon the Code .
ResponseTransmissionDateDate that the batch was settled.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
TerminalIdContains number to accommodate a POS device tracking number.
TimeoutA 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.

ConfigSets or retrieves a configuration setting.
InterruptInterrupts the current action.
ResetResets all the properties of the entire settlement to their default values.
SendSettlementBegins 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.

ConnectedFired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Config Settings


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

AmexAggregatorNameContains the name of the Payment Service Provider/Aggregator or Facilitator participating in Amex OptBlue program.
CombineRecordsWhether settlement records are being concatenated into a single settlement block.
DeviceCodeA 1-character value used to identify the device and type of the merchant submitting the settlement batch.
GenKeyA randomly generated string of alphanumeric characters identifying the terminal.
HeartlandDeviceIdSpecifies a device ID to uniquely identify each terminal (card data entry device).
HeartlandEncryptionModeSpecifies the encryption mode to use in Heartland transactions.
HeartlandKeyBlockSpecifies the key block used to encrypt the data.
LocationNumberProvides additional information on the location of the merchant.
PortThe port to which transactions are posted.
ProcessorSpecifies the Processor you are connecting to.
ServerThe server to which transactions are posted.
TravelAgencyCodeContains the Travel Agency IATA Code if the ticket was issued by a travel agency.
TravelAgencyNameContains the Travel Agency Name if the ticket was issued by a travel agency.
UseHTTPPOSTTells the class whether or not to use HTTP POST when transmitting the Batch for Settlement.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class 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

BatchCashBackTotal Property (TSYSSettle Class)

Total amount of cash back for all transactions in the batch.

Syntax

ANSI (Cross Platform)
char* GetBatchCashBackTotal();

Unicode (Windows)
LPWSTR GetBatchCashBackTotal();
char* dpaymentssdk_tsyssettle_getbatchcashbacktotal(void* lpObj);
QString GetBatchCashBackTotal();

Default Value

"0000000000000000"

Remarks

Total amount of cash back for all transactions in the batch.

This property 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 property will be defaulted to zeros.

This is a Trailer property, 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.

This property is read-only and not available at design time.

Data Type

String

BatchHashingTotal Property (TSYSSettle Class)

Total of purchases plus credits.

Syntax

ANSI (Cross Platform)
char* GetBatchHashingTotal();

Unicode (Windows)
LPWSTR GetBatchHashingTotal();
char* dpaymentssdk_tsyssettle_getbatchhashingtotal(void* lpObj);
QString GetBatchHashingTotal();

Default Value

"0000000000000000"

Remarks

Total of purchases plus credits.

This 16-digit property 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 property, 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.

This property is read-only and not available at design time.

Data Type

String

BatchNetDeposit Property (TSYSSettle Class)

Total of purchases minus credits.

Syntax

ANSI (Cross Platform)
char* GetBatchNetDeposit();

Unicode (Windows)
LPWSTR GetBatchNetDeposit();
char* dpaymentssdk_tsyssettle_getbatchnetdeposit(void* lpObj);
QString GetBatchNetDeposit();

Default Value

"0000000000000000"

Remarks

Total of purchases minus credits.

This 16-digit property 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 property, 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.

This property is read-only.

Data Type

String

BatchRecordCount Property (TSYSSettle Class)

Total number of records sent including Header, Parameter, and Trailer.

Syntax

ANSI (Cross Platform)
int GetBatchRecordCount();

Unicode (Windows)
INT GetBatchRecordCount();
int dpaymentssdk_tsyssettle_getbatchrecordcount(void* lpObj);
int GetBatchRecordCount();

Default Value

0

Remarks

Total number of records sent including Header, Parameter, and Trailer.

This property contains a batch (transaction) record count, calculated by the class. This property 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 property 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 property, and is automatically computed by the class.

This property is read-only.

Data Type

Integer

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 ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the class fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, 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

DetailRecordCount Property (TSYSSettle Class)

The number of records in the DetailRecord arrays.

Syntax

ANSI (Cross Platform)
int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount); Unicode (Windows) INT GetDetailRecordCount();
INT SetDetailRecordCount(INT iDetailRecordCount);
int dpaymentssdk_tsyssettle_getdetailrecordcount(void* lpObj);
int dpaymentssdk_tsyssettle_setdetailrecordcount(void* lpObj, int iDetailRecordCount);
int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at DetailRecordCount - 1.

This property is not available at design time.

Data Type

Integer

DetailRecordAddendum Property (TSYSSettle Class)

Optional Detail Record Addendum data (such as Level2 or Level3 data) The DetailAggregate property contains an xml aggregate of the transaction retrieved from the TSYSECOMMERCE , TSYSRETAIL , or TSYSDETAILRECORD class's GetDetailAggregate method.

Syntax

ANSI (Cross Platform)
char* GetDetailRecordAddendum(int iDetailRecordIndex);
int SetDetailRecordAddendum(int iDetailRecordIndex, const char* lpszDetailRecordAddendum); Unicode (Windows) LPWSTR GetDetailRecordAddendum(INT iDetailRecordIndex);
INT SetDetailRecordAddendum(INT iDetailRecordIndex, LPCWSTR lpszDetailRecordAddendum);
char* dpaymentssdk_tsyssettle_getdetailrecordaddendum(void* lpObj, int detailrecordindex);
int dpaymentssdk_tsyssettle_setdetailrecordaddendum(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAddendum);
QString GetDetailRecordAddendum(int iDetailRecordIndex);
int SetDetailRecordAddendum(int iDetailRecordIndex, QString qsDetailRecordAddendum);

Default Value

""

Remarks

Optional Detail Record Addendum data (such as Level2 or Level3 data)

The DetailRecordDetailAggregate property 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 DetailRecordDetailAggregate. The DetailRecordAddendumAggregate property takes an xml aggregate containing either Level2 or Level3 addendum data, which will be added to the DetailRecordDetailAggregate. 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 DetailRecordDetailAggregates have a corresponding DetailRecordAddendumAggregate.

The DetailRecordIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

DetailRecordAggregate Property (TSYSSettle Class)

Set this property with xml aggregates of the transactions you wish to settle.

Syntax

ANSI (Cross Platform)
char* GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, const char* lpszDetailRecordAggregate); Unicode (Windows) LPWSTR GetDetailRecordAggregate(INT iDetailRecordIndex);
INT SetDetailRecordAggregate(INT iDetailRecordIndex, LPCWSTR lpszDetailRecordAggregate);
char* dpaymentssdk_tsyssettle_getdetailrecordaggregate(void* lpObj, int detailrecordindex);
int dpaymentssdk_tsyssettle_setdetailrecordaggregate(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAggregate);
QString GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, QString qsDetailRecordAggregate);

Default Value

""

Remarks

Set this property with xml aggregates of the transactions you wish to settle.

To settle previously authorized transactions, this property 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()

The DetailRecordIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

ErrorData Property (TSYSSettle Class)

Erroneous data contained within the property specified by DataFieldNumber .

Syntax

ANSI (Cross Platform)
char* GetErrorData();

Unicode (Windows)
LPWSTR GetErrorData();
char* dpaymentssdk_tsyssettle_geterrordata(void* lpObj);
QString GetErrorData();

Default Value

""

Remarks

Erroneous data contained within the field specified by ErrorDataFieldNumber.

When you receive a Rejected Batch (ResponseCode is "RB"), this 32-character property will contain the data that caused the batch to fail. The record that contains this error is specified by ErrorSequenceNumber, and the location of the erroneous data within that record is specified by ErrorDataFieldNumber.

This property is read-only.

Data Type

String

ErrorDataFieldNumber Property (TSYSSettle Class)

Field within an invalid record that contains an error.

Syntax

ANSI (Cross Platform)
int GetErrorDataFieldNumber();

Unicode (Windows)
INT GetErrorDataFieldNumber();
int dpaymentssdk_tsyssettle_geterrordatafieldnumber(void* lpObj);
int GetErrorDataFieldNumber();

Default Value

0

Remarks

Field within an invalid record that contains an error.

When you receive a Rejected Batch (ResponseCode is "RB"), this property contains the sequential field number within the data record which caused the batch to be rejected. The erroneous data within this property is returned in ErrorData, and the sequence number of the record that contains this error is specified by ErrorSequenceNumber.

This property is read-only.

Data Type

Integer

ErrorDetailRecordIndex Property (TSYSSettle Class)

Provides the index of the DetailRecord that caused the batch error.

Syntax

ANSI (Cross Platform)
int GetErrorDetailRecordIndex();

Unicode (Windows)
INT GetErrorDetailRecordIndex();
int dpaymentssdk_tsyssettle_geterrordetailrecordindex(void* lpObj);
int GetErrorDetailRecordIndex();

Default Value

-1

Remarks

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

This property is read-only.

Data Type

Integer

ErrorType Property (TSYSSettle Class)

Type of batch error.

Syntax

ANSI (Cross Platform)
char* GetErrorType();

Unicode (Windows)
LPWSTR GetErrorType();
char* dpaymentssdk_tsyssettle_geterrortype(void* lpObj);
QString GetErrorType();

Default Value

""

Remarks

Type of batch error.

When you receive a Rejected Batch (ResponseCode is "RB"), this one character property will provide additional info as to the nature of the rejected batch. The following table lists the currently defined error types.

BBlocked terminal.
CCard type error.
DDevice error.
EError in Batch.
SSequence error.
TTransmission error.
UUnknown error.
VRouting error.

This property is read-only.

Data Type

String

ErrorRecordType Property (TSYSSettle Class)

Type of record in which an error occurred.

Syntax

ANSI (Cross Platform)
char* GetErrorRecordType();

Unicode (Windows)
LPWSTR GetErrorRecordType();
char* dpaymentssdk_tsyssettle_geterrorrecordtype(void* lpObj);
QString GetErrorRecordType();

Default Value

""

Remarks

Type of record in which an error occurred.

When you receive a Rejected Batch (ResponseCode is "RB"), this one character property defines the type of data record which caused the batch to be rejected. The table below lists all valid responses.

HHeader Record.
PParameter Record.
DDetail Record.
LLine Item Detail Record.
TTrailer Record.

This property is read-only.

Data Type

String

ErrorSequenceNumber Property (TSYSSettle Class)

Sequence number of the record that caused an error.

Syntax

ANSI (Cross Platform)
int GetErrorSequenceNumber();

Unicode (Windows)
INT GetErrorSequenceNumber();
int dpaymentssdk_tsyssettle_geterrorsequencenumber(void* lpObj);
int GetErrorSequenceNumber();

Default Value

0

Remarks

Sequence number of the record that caused an error.

When you receive a Rejected Batch (ResponseCode is "RB"), this property 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 ErrorDetailRecordIndex. The field within this record that contains erroneous data is specified by ErrorDataFieldNumber, and the actual data causing the error will be contained in the ErrorData property.

This property is read-only.

Data Type

Integer

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

MerchantBankId Property (TSYSSettle Class)

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

Syntax

ANSI (Cross Platform)
char* GetMerchantBankId();
int SetMerchantBankId(const char* lpszMerchantBankId); Unicode (Windows) LPWSTR GetMerchantBankId();
INT SetMerchantBankId(LPCWSTR lpszMerchantBankId);
char* dpaymentssdk_tsyssettle_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);
QString GetMerchantBankId();
int SetMerchantBankId(QString qsMerchantBankId);

Default Value

""

Remarks

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

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

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

Data Type

String

MerchantCategoryCode Property (TSYSSettle Class)

Classifies a merchant by the type of store.

Syntax

ANSI (Cross Platform)
char* GetMerchantCategoryCode();
int SetMerchantCategoryCode(const char* lpszMerchantCategoryCode); Unicode (Windows) LPWSTR GetMerchantCategoryCode();
INT SetMerchantCategoryCode(LPCWSTR lpszMerchantCategoryCode);
char* dpaymentssdk_tsyssettle_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);
QString GetMerchantCategoryCode();
int SetMerchantCategoryCode(QString qsMerchantCategoryCode);

Default Value

""

Remarks

Classifies a merchant by the type of store.

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

Data Type

String

MerchantCity Property (TSYSSettle Class)

Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.

Syntax

ANSI (Cross Platform)
char* GetMerchantCity();
int SetMerchantCity(const char* lpszMerchantCity); Unicode (Windows) LPWSTR GetMerchantCity();
INT SetMerchantCity(LPCWSTR lpszMerchantCity);
char* dpaymentssdk_tsyssettle_getmerchantcity(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcity(void* lpObj, const char* lpszMerchantCity);
QString GetMerchantCity();
int SetMerchantCity(QString qsMerchantCity);

Default Value

""

Remarks

Merchant's City

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

The first character of this property may not be a space and must contain the same data used in the batch settlement.

Note that this property is ignored for Direct Marketing and E-Commerce transactions. MerchantServicePhone is used for those industries instead of MerchantCity.

This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.

Data Type

String

MerchantCountryCode Property (TSYSSettle Class)

Identifies the country where the merchant is located.

Syntax

ANSI (Cross Platform)
char* GetMerchantCountryCode();
int SetMerchantCountryCode(const char* lpszMerchantCountryCode); Unicode (Windows) LPWSTR GetMerchantCountryCode();
INT SetMerchantCountryCode(LPCWSTR lpszMerchantCountryCode);
char* dpaymentssdk_tsyssettle_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);
QString GetMerchantCountryCode();
int SetMerchantCountryCode(QString qsMerchantCountryCode);

Default Value

"840"

Remarks

Identifies the country where the merchant is located.

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

Data Type

String

MerchantCurrencyCode Property (TSYSSettle Class)

Identifies the type of currency used by the merchant.

Syntax

ANSI (Cross Platform)
char* GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(const char* lpszMerchantCurrencyCode); Unicode (Windows) LPWSTR GetMerchantCurrencyCode();
INT SetMerchantCurrencyCode(LPCWSTR lpszMerchantCurrencyCode);
char* dpaymentssdk_tsyssettle_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);
QString GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(QString qsMerchantCurrencyCode);

Default Value

"840"

Remarks

Identifies the type of currency used by the merchant.

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

Data Type

String

MerchantLanguage Property (TSYSSettle Class)

Designates the language that response messages will be returned in.

Syntax

ANSI (Cross Platform)
char* GetMerchantLanguage();
int SetMerchantLanguage(const char* lpszMerchantLanguage); Unicode (Windows) LPWSTR GetMerchantLanguage();
INT SetMerchantLanguage(LPCWSTR lpszMerchantLanguage);
char* dpaymentssdk_tsyssettle_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);
QString GetMerchantLanguage();
int SetMerchantLanguage(QString qsMerchantLanguage);

Default Value

"00"

Remarks

Designates the language that response messages will be returned in.

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

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

Data Type

String

MerchantName Property (TSYSSettle Class)

Name of the merchant.

Syntax

ANSI (Cross Platform)
char* GetMerchantName();
int SetMerchantName(const char* lpszMerchantName); Unicode (Windows) LPWSTR GetMerchantName();
INT SetMerchantName(LPCWSTR lpszMerchantName);
char* dpaymentssdk_tsyssettle_getmerchantname(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantname(void* lpObj, const char* lpszMerchantName);
QString GetMerchantName();
int SetMerchantName(QString qsMerchantName);

Default Value

""

Remarks

Name of the merchant.

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

This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.

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

Data Type

String

MerchantNumber Property (TSYSSettle Class)

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

Syntax

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber); Unicode (Windows) LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);
char* dpaymentssdk_tsyssettle_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);
QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

Default Value

""

Remarks

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

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

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

Data Type

String

MerchantPhone Property (TSYSSettle Class)

Merchant's phone number.

Syntax

ANSI (Cross Platform)
char* GetMerchantPhone();
int SetMerchantPhone(const char* lpszMerchantPhone); Unicode (Windows) LPWSTR GetMerchantPhone();
INT SetMerchantPhone(LPCWSTR lpszMerchantPhone);
char* dpaymentssdk_tsyssettle_getmerchantphone(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);
QString GetMerchantPhone();
int SetMerchantPhone(QString qsMerchantPhone);

Default Value

""

Remarks

Merchant's phone number.

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

Data Type

String

MerchantServicePhone Property (TSYSSettle Class)

Merchant's customer service number.

Syntax

ANSI (Cross Platform)
char* GetMerchantServicePhone();
int SetMerchantServicePhone(const char* lpszMerchantServicePhone); Unicode (Windows) LPWSTR GetMerchantServicePhone();
INT SetMerchantServicePhone(LPCWSTR lpszMerchantServicePhone);
char* dpaymentssdk_tsyssettle_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);
QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone);

Default Value

""

Remarks

Merchant's customer service number.

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

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

Data Type

String

MerchantState Property (TSYSSettle Class)

State or province that the merchant is located in.

Syntax

ANSI (Cross Platform)
char* GetMerchantState();
int SetMerchantState(const char* lpszMerchantState); Unicode (Windows) LPWSTR GetMerchantState();
INT SetMerchantState(LPCWSTR lpszMerchantState);
char* dpaymentssdk_tsyssettle_getmerchantstate(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantstate(void* lpObj, const char* lpszMerchantState);
QString GetMerchantState();
int SetMerchantState(QString qsMerchantState);

Default Value

""

Remarks

State or province that the merchant is located in.

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

This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.

Data Type

String

MerchantStoreNumber Property (TSYSSettle Class)

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

Syntax

ANSI (Cross Platform)
char* GetMerchantStoreNumber();
int SetMerchantStoreNumber(const char* lpszMerchantStoreNumber); Unicode (Windows) LPWSTR GetMerchantStoreNumber();
INT SetMerchantStoreNumber(LPCWSTR lpszMerchantStoreNumber);
char* dpaymentssdk_tsyssettle_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);
QString GetMerchantStoreNumber();
int SetMerchantStoreNumber(QString qsMerchantStoreNumber);

Default Value

""

Remarks

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

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

Data Type

String

MerchantStreetAddress Property (TSYSSettle Class)

Merchant's street address.

Syntax

ANSI (Cross Platform)
char* GetMerchantStreetAddress();
int SetMerchantStreetAddress(const char* lpszMerchantStreetAddress); Unicode (Windows) LPWSTR GetMerchantStreetAddress();
INT SetMerchantStreetAddress(LPCWSTR lpszMerchantStreetAddress);
char* dpaymentssdk_tsyssettle_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);
QString GetMerchantStreetAddress();
int SetMerchantStreetAddress(QString qsMerchantStreetAddress);

Default Value

""

Remarks

Merchant's street address.

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

Data Type

String

MerchantTerminalNumber Property (TSYSSettle Class)

Used to identify a unique terminal within a merchant location.

Syntax

ANSI (Cross Platform)
char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber); Unicode (Windows) LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);
char* dpaymentssdk_tsyssettle_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);
QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);

Default Value

""

Remarks

Used to identify a unique terminal within a merchant location.

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

Data Type

String

MerchantTimeZone Property (TSYSSettle Class)

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

Syntax

ANSI (Cross Platform)
char* GetMerchantTimeZone();
int SetMerchantTimeZone(const char* lpszMerchantTimeZone); Unicode (Windows) LPWSTR GetMerchantTimeZone();
INT SetMerchantTimeZone(LPCWSTR lpszMerchantTimeZone);
char* dpaymentssdk_tsyssettle_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);
QString GetMerchantTimeZone();
int SetMerchantTimeZone(QString qsMerchantTimeZone);

Default Value

"705"

Remarks

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

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

Byte #1:

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

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

Data Type

String

MerchantZip Property (TSYSSettle Class)

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

Syntax

ANSI (Cross Platform)
char* GetMerchantZip();
int SetMerchantZip(const char* lpszMerchantZip); Unicode (Windows) LPWSTR GetMerchantZip();
INT SetMerchantZip(LPCWSTR lpszMerchantZip);
char* dpaymentssdk_tsyssettle_getmerchantzip(void* lpObj);
int dpaymentssdk_tsyssettle_setmerchantzip(void* lpObj, const char* lpszMerchantZip);
QString GetMerchantZip();
int SetMerchantZip(QString qsMerchantZip);

Default Value

""

Remarks

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

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

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

Data Type

String

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 property is only used in the settlement, and will be ignored for all authorizations.

Data Type

String

ResponseCode Property (TSYSSettle Class)

Indicates the status of the batch transmission.

Syntax

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();
char* dpaymentssdk_tsyssettle_getresponsecode(void* lpObj);
QString GetResponseCode();

Default Value

""

Remarks

Indicates the status of the batch transmission.

This property 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:

GBGood Batch.
QDDuplicate Batch.
RBRejected Batch.

This property is read-only and not available at design time.

Data Type

String

ResponseNetDeposit Property (TSYSSettle Class)

Total of purchases minus credits and voids.

Syntax

ANSI (Cross Platform)
char* GetResponseNetDeposit();

Unicode (Windows)
LPWSTR GetResponseNetDeposit();
char* dpaymentssdk_tsyssettle_getresponsenetdeposit(void* lpObj);
QString GetResponseNetDeposit();

Default Value

""

Remarks

Total of purchases minus credits and voids.

This property contains the net deposit generated by the terminal. It should equal the BatchNetDesposit property, 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 property 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.

This property is read-only and not available at design time.

Data Type

String

ResponseNumber Property (TSYSSettle Class)

Batch number that belongs to this response.

Syntax

ANSI (Cross Platform)
int GetResponseNumber();

Unicode (Windows)
INT GetResponseNumber();
int dpaymentssdk_tsyssettle_getresponsenumber(void* lpObj);
int GetResponseNumber();

Default Value

0

Remarks

Batch number that belongs to this response.

This property should be compared to the BatchNumber in order to match a response with a given Batch Settlement. If running in synchronous mode, this property should always be identical to BatchNumber.

This property is read-only and not available at design time.

Data Type

Integer

ResponseRecordCount Property (TSYSSettle Class)

Number of records received by the server in this batch.

Syntax

ANSI (Cross Platform)
int GetResponseRecordCount();

Unicode (Windows)
INT GetResponseRecordCount();
int dpaymentssdk_tsyssettle_getresponserecordcount(void* lpObj);
int GetResponseRecordCount();

Default Value

0

Remarks

Number of records received by the server in this batch.

This property contains the total number of records received by the host -- including Header, Parameter, Detail, and Trailer records. In the case of a ResponseCode of "GB" (Good Batch), the value returned should match the value in the Batch.RecordCount property. In the case of a ResponseCode of "RB" (Rejected Batch), this property will reflect the total number of records received until the point of failure. ResponseRecordCount + 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 property in this case.

This property is read-only and not available at design time.

Data Type

Integer

ResponseText Property (TSYSSettle Class)

Contents of this property are dependent upon the Code .

Syntax

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();
char* dpaymentssdk_tsyssettle_getresponsetext(void* lpObj);
QString GetResponseText();

Default Value

""

Remarks

Contents of this field are dependent upon the ResponseCode.

This nine character property 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 ResponseCode to determine the status of a particular Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransmissionDate Property (TSYSSettle Class)

Date that the batch was settled.

Syntax

ANSI (Cross Platform)
char* GetResponseTransmissionDate();

Unicode (Windows)
LPWSTR GetResponseTransmissionDate();
char* dpaymentssdk_tsyssettle_getresponsetransmissiondate(void* lpObj);
QString GetResponseTransmissionDate();

Default Value

""

Remarks

Date that the batch was settled.

This property is reserved, pending the future upgrade to a higher protocol version.

This property is read-only and not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (TSYSSettle Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsyssettle_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsyssettle_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (TSYSSettle Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int dpaymentssdk_tsyssettle_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsyssettle_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (TSYSSettle Class)

This is the name of the certificate store for the client certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int dpaymentssdk_tsyssettle_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsyssettle_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (TSYSSettle Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* dpaymentssdk_tsyssettle_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsyssettle_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (TSYSSettle Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int dpaymentssdk_tsyssettle_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsyssettle_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 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 PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (TSYSSettle Class)

This is the subject of the certificate used for client authentication.

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* dpaymentssdk_tsyssettle_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsyssettle_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (TSYSSettle Class)

This specifies the SSL/TLS implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int dpaymentssdk_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:

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

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

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

Data Type

Integer

SSLServerCertEncoded Property (TSYSSettle Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int dpaymentssdk_tsyssettle_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

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

This property is read-only and not available at design time.

Data Type

Binary String

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 ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the class fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, 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

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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)

Shows the progress of the secure connection.

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. Used to track the progress of the connection.

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

AmexAggregatorName:   Contains the name of the Payment Service Provider/Aggregator or Facilitator participating in Amex OptBlue program.

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.

CombineRecords:   Whether settlement records are being concatenated into a single settlement block.

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.

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

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

0Unknown or unsure.
BAutomated Teller Machine (ATM).
CPersonal Computer (PC)
DDial terminal
EElectronic Cash Register (ECR)
GMobile Payment Acceptance.
HTSYS Hosted Payment.
IIn-store processor
JMulti Payment Acceptance.
MMainframe
PPOS-Port
QThird-party developer
RPOS-Port
SPOS Partner
TCounter Payment Acceptance.
WWeb Payment Acceptance.
XEMV Mode Contact and/or Contactless terminal (Must be used on all EMV mode chip card transactions).
ZSuppress PS2000/Merit fields

GenKey:   A randomly generated string of alphanumeric characters identifying the terminal.

This field is used to specify retrieve or specify a GenKey value for a terminal. This field will be populated after a successful call to ActivateTerminal is made. The Genkey must be stored in the POS device, must be sent with every request to the TSYS Acquiring Solutions host after authentication (by setting this field), and will be checked against the terminal hierarchy. A GenKey value is required when processing transactions using Voltage Encryption or Tokenization.

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

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

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

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

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

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

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

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

LocationNumber:   Provides additional information on the location of the merchant.

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.

Port:   The port to which transactions are posted.

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

Processor:   Specifies the Processor you are connecting to.

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

0TSYS (default)
1Heartland

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

Server:   The server to which transactions are posted.

This is name of the server to which all transactions are posted. Do not use an IP address, use the actual name, as a server's IP address may change. The default (Live) TSYS server is "ssl2.vitalps.net", but you may use "ssltest.tsysacquiring.net" for testing. The default (Live) Heartland server is "txns.secureexchange.net", but you may use "test.txns.secureexchange.net" for testing. Note that there are several MerchantBankIds and MerchantNumbers that will always run in test mode regardless of whether you are using the live server. See the included demos for examples.

TravelAgencyCode:   Contains the Travel Agency IATA Code if the ticket was issued by a travel agency.

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.

TravelAgencyName:   Contains the Travel Agency Name if the ticket was issued by a travel agency.

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.

UseHTTPPOST:   Tells the component whether or not to use HTTP POST when transmitting the Batch for Settlement.

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

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

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

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

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

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

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

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

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

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

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

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

FirewallPort:   The TCP port for the FirewallHost;.

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

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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

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

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

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

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

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

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

Note: This value is not applicable in macOS.

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

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

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

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

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

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

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

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

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

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

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

LingerTime:   Time in seconds to have the connection linger.

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

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

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

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

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

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

This 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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

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

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

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

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

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

MaxTransferRate:   The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

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

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

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

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful 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 setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

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

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

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

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

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

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength 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.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

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

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

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

The enabled 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: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

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

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This 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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

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 setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when 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 setting should only be set 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 setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This 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 setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

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

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This 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 round trip 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 setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified 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

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which 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 UDP ports.

FirewallData:   Used to send extra data to the firewall.

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

InBufferSize:   The size in bytes of the incoming queue of the socket.

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 receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

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

LicenseInfo:   Information about the current license.

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.
MaskSensitive:   Whether sensitive data is masked in log messages.

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.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

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.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

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.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this 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 MerchantNumber and MerchantBankId).
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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).