TSYSHCReversal Class
Properties Methods Events Config Settings Errors
The TSYSHCReversal class is used to reverse a previously authorized transaction. This class makes reversing transactions very easy.
Syntax
TSYSHCReversal
Remarks
This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
The TSYSHCReversal class makes reversing transactions very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:
First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:
TSYSHCReversal1.GenKey = "gen_key_value"
TSYSHCReversal1.MerchantId = "merchant_id"
TSYSHCReversal1.RoutingId = "routing_id"
Next, set properties that contain details about the transaction. At a minimum, you must set a RetrievalNumber, TransactionAmount, and TransactionType.
TSYSHCReversal1.TransactionType = ttCreditAuthorizationReversal
TSYSHCReversal1.TransactionAmount = TSYSHCRetail1.TransactionAmount
TSYSHCReversal1.RetrievalNumber = TSYSHCRetail1.Response.RetrievalNumber
TSYSHCReversal1.CardType = TSYSHCRetail1.Response.CardType;
Finally, submit the transaction reversal request by calling Reverse.
TSYSHCReversal1.Reverse()
When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the reversal was approved. The remaining properties provide additional information about the transaction.
Once a reversal is approved, it is added to the current batch. The transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr class.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
CardType | Type of the credit card. |
CashBackAmount | Amount returned to the customer in cash. |
GenKey | The unique GenKey value used to identify a POS device. |
MerchantId | The unique ID that associates the POS device with the merchant account. |
RepeatIndicator | Indicates whether a transaction is a repeat of a previous transaction attempt. |
ResponseBatchNumber | Contains the incrementing ID assigned by TSYS to identify a merchant batch. |
ResponseCode | Indicates the status of the authorization request. |
ResponseRetrievalNumber | This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement. |
ResponseText | Text information that describes each response code. |
ResponseTransactionDate | Local transaction date returned from the server in MMddyy format. |
ResponseTransactionNumber | Check this property against the original Transaction Number. |
ResponseTransactionTime | Local transaction time returned from the server in HHmmss format. |
RetrievalNumber | The retrieval reference number (RRN) used to identify a transaction. |
RoutingId | The Routing ID assigned to the merchant by TSYS. |
SettleAmount | The final settlement amount. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Timeout | A timeout for the class. |
TransactionAmount | Purchase amount to be authorized. |
TransactionDesc | Soft (Dynamic) Descriptor. |
TransactionNumber | Sequence number of this transaction. |
TransactionType | Specifies the original transaction type that you wish to reverse. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Interrupt | Interrupts the current action. |
Reset | Clears all properties to their default values. |
Reverse | Performs a reversal transaction. |
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.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
AuthorizationIndicator | The type of authorization request. |
ECI | Electronic Commerce Indicator. |
IsBillPayment | Indicates that the transaction being reversed is a bill payment transaction. |
Language | Indicates the language to be used in formatting the authorization response text message. |
MessageReasonCode | The reversal message reason code used to identify why the reversal is being made. |
POSAcceptanceDeviceType | Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions. |
POSAuthEntity | The authentication entity to indicate the circumstances in which card data was entered at the POS. |
POSCardCaptureCapability | Card capture capability data to indicate the circumstances in which card data was entered at the POS. |
POSCardholderAuthCapability | Cardholder authentication capability data to indicate the circumstances in which card data was entered at the POS. |
POSCardholderAuthMethod | Cardholder authentication method to indicate the circumstances in which card data was entered at the POS. |
POSCardholderPresent | Cardholder present data to indicate the circumstances in which card data was entered at the POS. |
POSCardInputCapability | Card input capability data to indicate the circumstances in which card data was entered at the POS. |
POSCardInputMode | Card input mode to indicate the circumstances in which card data was entered at the POS. |
POSCardOutputCapability | Card output capability data to indicate the circumstances in which card data was entered at the POS. |
POSCardPresent | Card present data to indicate the circumstances in which card data was entered at the POS. |
POSChipConditionCode | Chip condition code to indicate the circumstances in which card data was entered at the POS. |
POSCITMITIndicator | CIT/MIT Indicator. |
POSOperatingEnvironment | Operating environment data to indicate the circumstances in which card data was entered at the POS. |
POSPINCaptureCapability | PIN capture capability data to indicate the circumstances in which card data was entered at the POS. |
POSTerminalOutputCapability | Terminal output capability data to indicate the circumstances in which card data was entered at the POS. |
POSTransactionStatus | A 1-character value used to indicate the purpose or status of the request. |
RawRequest | Returns the request sent to the server for debugging purposes. |
RawResponse | Returns the response received from the server for debugging purposes. |
ServerURL | The server to which transactions are posted. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
CardType Property (TSYSHCReversal Class)
Type of the credit card.
Syntax
ANSI (Cross Platform) char* GetCardType();
int SetCardType(const char* lpszCardType); Unicode (Windows) LPWSTR GetCardType();
INT SetCardType(LPCWSTR lpszCardType);
char* dpaymentssdk_tsyshcreversal_getcardtype(void* lpObj);
int dpaymentssdk_tsyshcreversal_setcardtype(void* lpObj, const char* lpszCardType);
QString GetCardType();
int SetCardType(QString qsCardType);
Default Value
""
Remarks
TSYS determines the type of credit card used for each authorization, and returns that value to the
merchant in the response. The following example shows how to set CardType property from the response of the TSYSHCRetail component:
TSYSHCReversal1.CardType = TSYSHCRetail1.Response.RetrievalNumber;
Possible values are:
- VISA
- MASTERCARD
- AMEX
- DISCOVER
- JCB
- PRIVATE LABEL
- GIFT CARD
- DEBIT
- EBT
Data Type
String
CashBackAmount Property (TSYSHCReversal Class)
Amount returned to the customer in cash.
Syntax
ANSI (Cross Platform) char* GetCashBackAmount();
int SetCashBackAmount(const char* lpszCashBackAmount); Unicode (Windows) LPWSTR GetCashBackAmount();
INT SetCashBackAmount(LPCWSTR lpszCashBackAmount);
char* dpaymentssdk_tsyshcreversal_getcashbackamount(void* lpObj);
int dpaymentssdk_tsyshcreversal_setcashbackamount(void* lpObj, const char* lpszCashBackAmount);
QString GetCashBackAmount();
int SetCashBackAmount(QString qsCashBackAmount);
Default Value
""
Remarks
This property may contain an optional cash back amount when authorizing a Debit Purchase transaction, EBT Cash Benefit Purchase, or a Gift Card Purchase transaction. The value of TransactionAmount must reflect the cost of the goods or service purchased plus this CashBackAmount.
Note: CashBackAmount must be empty for Restaurant IndustryType as this is not supported by TSYS.
Note: TSYS does not support transactions containing both CashBack and Gratuity/Tip amounts.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
Note: For EBT Withdrawal transactions, CashBackAmount must be empty. However, when creating detail records for the settlement of the transaction, the DebitCashBack in the detail record must match the TransactionAmount for the authorization.
Data Type
String
GenKey Property (TSYSHCReversal Class)
The unique GenKey value used to identify a POS device.
Syntax
ANSI (Cross Platform) char* GetGenKey();
int SetGenKey(const char* lpszGenKey); Unicode (Windows) LPWSTR GetGenKey();
INT SetGenKey(LPCWSTR lpszGenKey);
char* dpaymentssdk_tsyshcreversal_getgenkey(void* lpObj);
int dpaymentssdk_tsyshcreversal_setgenkey(void* lpObj, const char* lpszGenKey);
QString GetGenKey();
int SetGenKey(QString qsGenKey);
Default Value
""
Remarks
This property is used to specify the unique GenKey value used to identify the POS device to the host capture system. This property is required to be specified in every transaction performed.
Your GenKey value is obtained from the host capture system when you successfully authenticate your POS device, which can be accomplished by calling AuthenticateDevice. Once retrieved, your GenKey value must be stored in the POS device.
Data Type
String
MerchantId Property (TSYSHCReversal Class)
The unique ID that associates the POS device with the merchant account.
Syntax
ANSI (Cross Platform) char* GetMerchantId();
int SetMerchantId(const char* lpszMerchantId); Unicode (Windows) LPWSTR GetMerchantId();
INT SetMerchantId(LPCWSTR lpszMerchantId);
char* dpaymentssdk_tsyshcreversal_getmerchantid(void* lpObj);
int dpaymentssdk_tsyshcreversal_setmerchantid(void* lpObj, const char* lpszMerchantId);
QString GetMerchantId();
int SetMerchantId(QString qsMerchantId);
Default Value
""
Remarks
The unique ID, also known as the POS ID, that associates the POS device with the merchant account.
This property is required to be specified in every transaction performed.
Data Type
String
RepeatIndicator Property (TSYSHCReversal Class)
Indicates whether a transaction is a repeat of a previous transaction attempt.
Syntax
ANSI (Cross Platform) int GetRepeatIndicator();
int SetRepeatIndicator(int bRepeatIndicator); Unicode (Windows) BOOL GetRepeatIndicator();
INT SetRepeatIndicator(BOOL bRepeatIndicator);
int dpaymentssdk_tsyshcreversal_getrepeatindicator(void* lpObj);
int dpaymentssdk_tsyshcreversal_setrepeatindicator(void* lpObj, int bRepeatIndicator);
bool GetRepeatIndicator();
int SetRepeatIndicator(bool bRepeatIndicator);
Default Value
FALSE
Remarks
This property allows you to specify whether a transaction is a repeat of a previous transaction attempt.
If a timeout exception occurs, such as the host capture system not receiving the request or the response not being received from the host capture system, you can set RepeatIndicator to true and resend the request using the original transaction details. In the case that the host capture system received the original transaction, it has already been logged and will respond with existing Response details. In the case that the host capture system did not receive the original transaction, it will process the request normally.
Note: Repeat transactions are not allowed for gift card and debit transactions.
Data Type
Boolean
ResponseBatchNumber Property (TSYSHCReversal Class)
Contains the incrementing ID assigned by TSYS to identify a merchant batch.
Syntax
ANSI (Cross Platform) int GetResponseBatchNumber(); Unicode (Windows) INT GetResponseBatchNumber();
int dpaymentssdk_tsyshcreversal_getresponsebatchnumber(void* lpObj);
int GetResponseBatchNumber();
Default Value
0
Remarks
Contains the incrementing ID assigned by TSYS to identify a merchant batch.
The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.
Note that if CaptureMode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See CaptureMode for more details.
This property is read-only.
Data Type
Integer
ResponseCode Property (TSYSHCReversal Class)
Indicates the status of the authorization request.
Syntax
ANSI (Cross Platform) char* GetResponseCode(); Unicode (Windows) LPWSTR GetResponseCode();
char* dpaymentssdk_tsyshcreversal_getresponsecode(void* lpObj);
QString GetResponseCode();
Default Value
""
Remarks
Indicates the status of the authorization request.
This property contains the response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents an approval. A response code of "10" indicates that the transaction was partially approved for a lesser amount (ResponseAuthorizedAmount). All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".
A list of valid result ResponseCodes are listed in the table of contents.
This property is read-only.
Data Type
String
ResponseRetrievalNumber Property (TSYSHCReversal Class)
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
Syntax
ANSI (Cross Platform) char* GetResponseRetrievalNumber(); Unicode (Windows) LPWSTR GetResponseRetrievalNumber();
char* dpaymentssdk_tsyshcreversal_getresponseretrievalnumber(void* lpObj);
QString GetResponseRetrievalNumber();
Default Value
""
Remarks
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
This property contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.
This property is read-only and not available at design time.
Data Type
String
ResponseText Property (TSYSHCReversal Class)
Text information that describes each response code.
Syntax
ANSI (Cross Platform) char* GetResponseText(); Unicode (Windows) LPWSTR GetResponseText();
char* dpaymentssdk_tsyshcreversal_getresponsetext(void* lpObj);
QString GetResponseText();
Default Value
""
Remarks
Text information that describes each response code.
This property contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.
The English-language response text messages are listed in the table of contents.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionDate Property (TSYSHCReversal Class)
Local transaction date returned from the server in MMddyy format.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionDate(); Unicode (Windows) LPWSTR GetResponseTransactionDate();
char* dpaymentssdk_tsyshcreversal_getresponsetransactiondate(void* lpObj);
QString GetResponseTransactionDate();
Default Value
""
Remarks
Local transaction date returned from the server in MMddyy format.
This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionNumber Property (TSYSHCReversal Class)
Check this property against the original Transaction Number.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionNumber(); Unicode (Windows) LPWSTR GetResponseTransactionNumber();
char* dpaymentssdk_tsyshcreversal_getresponsetransactionnumber(void* lpObj);
QString GetResponseTransactionNumber();
Default Value
""
Remarks
Check this property against the original Transaction Number.
This property should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this property should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionTime Property (TSYSHCReversal Class)
Local transaction time returned from the server in HHmmss format.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionTime(); Unicode (Windows) LPWSTR GetResponseTransactionTime();
char* dpaymentssdk_tsyshcreversal_getresponsetransactiontime(void* lpObj);
QString GetResponseTransactionTime();
Default Value
""
Remarks
Local transaction time returned from the server in HHmmss format.
This six digit property contains the Local Transaction Time returned by the authorizing system. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
RetrievalNumber Property (TSYSHCReversal Class)
The retrieval reference number (RRN) used to identify a transaction.
Syntax
ANSI (Cross Platform) char* GetRetrievalNumber();
int SetRetrievalNumber(const char* lpszRetrievalNumber); Unicode (Windows) LPWSTR GetRetrievalNumber();
INT SetRetrievalNumber(LPCWSTR lpszRetrievalNumber);
char* dpaymentssdk_tsyshcreversal_getretrievalnumber(void* lpObj);
int dpaymentssdk_tsyshcreversal_setretrievalnumber(void* lpObj, const char* lpszRetrievalNumber);
QString GetRetrievalNumber();
int SetRetrievalNumber(QString qsRetrievalNumber);
Default Value
""
Remarks
This property is used to specify the retrieval reference number (RRN) for the transaction that you wish to retrieve or adjust. This value is used by the Host Capture system to identify the transaction.
Note either RetrievalNumber or TransactionNumber may be used to reference the transaction that is to be retrieved, adjusted or voided. If both are supplied, the RetrievalNumber will be used and the TransactionNumber ignored.
In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.
Data Type
String
RoutingId Property (TSYSHCReversal Class)
The Routing ID assigned to the merchant by TSYS.
Syntax
ANSI (Cross Platform) char* GetRoutingId();
int SetRoutingId(const char* lpszRoutingId); Unicode (Windows) LPWSTR GetRoutingId();
INT SetRoutingId(LPCWSTR lpszRoutingId);
char* dpaymentssdk_tsyshcreversal_getroutingid(void* lpObj);
int dpaymentssdk_tsyshcreversal_setroutingid(void* lpObj, const char* lpszRoutingId);
QString GetRoutingId();
int SetRoutingId(QString qsRoutingId);
Default Value
""
Remarks
This property is used to specify the six alphanumeric character routing ID assigned to you via TSYS.
This property is required to be set for every transaction request.
Data Type
String
SettleAmount Property (TSYSHCReversal Class)
The final settlement amount.
Syntax
ANSI (Cross Platform) char* GetSettleAmount();
int SetSettleAmount(const char* lpszSettleAmount); Unicode (Windows) LPWSTR GetSettleAmount();
INT SetSettleAmount(LPCWSTR lpszSettleAmount);
char* dpaymentssdk_tsyshcreversal_getsettleamount(void* lpObj);
int dpaymentssdk_tsyshcreversal_setsettleamount(void* lpObj, const char* lpszSettleAmount);
QString GetSettleAmount();
int SetSettleAmount(QString qsSettleAmount);
Default Value
""
Remarks
This property is used when running a Partial Reversal transaction to specify the final settlement (transaction) amount. The final settlement amount can only be decreased. Thus SettleAmount must be less than TransactionAmount. If you wish to perform a Full Reversal you should not set SettleAmount.
Note: Partial Reversals are not supported by Amex.
Data Type
String
SSLAcceptServerCertEncoded Property (TSYSHCReversal 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_tsyshcreversal_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsyshcreversal_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 (TSYSHCReversal 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_tsyshcreversal_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsyshcreversal_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 (TSYSHCReversal 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_tsyshcreversal_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsyshcreversal_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (TSYSHCReversal 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_tsyshcreversal_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsyshcreversal_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 (TSYSHCReversal 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_tsyshcreversal_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsyshcreversal_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (TSYSHCReversal 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_tsyshcreversal_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsyshcreversal_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLProvider Property (TSYSHCReversal 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_tsyshcreversal_getsslprovider(void* lpObj);
int dpaymentssdk_tsyshcreversal_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEncoded Property (TSYSHCReversal 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_tsyshcreversal_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (TSYSHCReversal 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_tsyshcreversal_gettimeout(void* lpObj);
int dpaymentssdk_tsyshcreversal_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
TransactionAmount Property (TSYSHCReversal Class)
Purchase amount to be authorized.
Syntax
ANSI (Cross Platform) char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount); Unicode (Windows) LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);
char* dpaymentssdk_tsyshcreversal_gettransactionamount(void* lpObj);
int dpaymentssdk_tsyshcreversal_settransactionamount(void* lpObj, const char* lpszTransactionAmount);
QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);
Default Value
""
Remarks
This field contains the transaction amount to be authorized.
The transaction amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.
The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated MerchantCurrencyCode. In the United States, the number of allowable significant digits is seven. Thus the maximum t transaction amount; is "9999999", yielding a US dollar amount of $99,999.99.
Note: This field may not contain a negative number.
Data Type
String
TransactionDesc Property (TSYSHCReversal Class)
Soft (Dynamic) Descriptor.
Syntax
ANSI (Cross Platform) char* GetTransactionDesc();
int SetTransactionDesc(const char* lpszTransactionDesc); Unicode (Windows) LPWSTR GetTransactionDesc();
INT SetTransactionDesc(LPCWSTR lpszTransactionDesc);
char* dpaymentssdk_tsyshcreversal_gettransactiondesc(void* lpObj);
int dpaymentssdk_tsyshcreversal_settransactiondesc(void* lpObj, const char* lpszTransactionDesc);
QString GetTransactionDesc();
int SetTransactionDesc(QString qsTransactionDesc);
Default Value
""
Remarks
This property allows a merchant to specify a description about the transaction.
The maximum length of this property is 25 characters (alphanumeric and special characters).
Data Type
String
TransactionNumber Property (TSYSHCReversal Class)
Sequence number of this transaction.
Syntax
ANSI (Cross Platform) int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber); Unicode (Windows) INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);
int dpaymentssdk_tsyshcreversal_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsyshcreversal_settransactionnumber(void* lpObj, int iTransactionNumber);
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);
Default Value
0
Remarks
This number must be unique, it's used to identify the transaction in order to operate on it in the future.
This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages.
The maximum length of this property is 8 characters.
TSYS suggests the following application rules for the format of TransactionNumber:
- Format the TransactionNumber as "DDSSS", where DD is the current day of the month and SSS is a sequence of numbers from 001-999.
- Configure the sequence number for 2-5 positions so the sequence number can increment through a single day without rolling over.
- Allow the sequence to increment and roll-over. Do not program the TransactionNumber to reset when a batch close occurs.
Data Type
Integer
TransactionType Property (TSYSHCReversal Class)
Specifies the original transaction type that you wish to reverse.
Syntax
ANSI (Cross Platform) int GetTransactionType();
int SetTransactionType(int iTransactionType); Unicode (Windows) INT GetTransactionType();
INT SetTransactionType(INT iTransactionType);
Possible Values
TT_CREDIT_AUTHORIZATION_REVERSAL(0),
TT_DEBIT_AUTHORIZATION_REVERSAL(1),
TT_DEBIT_CREDIT_REVERSAL(2),
TT_GIFT_CARD_AUTHORIZATION_REVERSAL(3),
TT_FOOD_STAMP_AUTHORIZATION_REVERSAL(4),
TT_CASH_BENEFIT_AUTHORIZATION_REVERSAL(5),
TT_FOOD_STAMP_CREDIT_REVERSAL(6),
TT_CASH_BENEFIT_CREDIT_REVERSAL(7)
int dpaymentssdk_tsyshcreversal_gettransactiontype(void* lpObj);
int dpaymentssdk_tsyshcreversal_settransactiontype(void* lpObj, int iTransactionType);
int GetTransactionType();
int SetTransactionType(int iTransactionType);
Default Value
0
Remarks
This property indicates the original transaction type that you want to reverse. The following table explains the transaction types in detail:
ttCreditAuthorizationReversal (0) | This transaction reverses a previous credit card purchase transaction (also known as Online Authorization Reversal). This type should be used when reversing a TSYSHCRetail or TSYSHCECommerce authorization transaction. |
ttDebitAuthorizationReversal (1) | This transaction reverses a previous debit card purchase transaction. This type should be used when reversing a TSYSHCDebit authorization transaction. |
ttDebitCreditReversal (2) | This transaction reverses a previous debit card refund transaction. This type should be used when reversing a TSYSHCDebit credit transaction. |
ttGiftCardAuthorizationReversal (3) | This transaction reverses a previous gift card purchase transaction. This type should be used when reversing a TSYSHCGIFTCARD authorization transaction. |
ttFoodStampAuthorizationReversal (4) | This transaction reverses a previous EBT card Food Stamp purchase transaction. This type should be used when reversing a TSYSHCBenefit authorization transaction. |
ttCashBenefitAuthorizationReversal (5) | This transaction reverses a previous EBT card Cash Benefit purchase transaction. This type should be used when reversing a TSYSHCBenefit authorization transaction. |
ttFoodStampCreditReversal (2) | This transaction reverses a previous EBT card Food Stamp refund transaction. This type should be used when reversing a TSYSHCBenefit credit transaction. |
ttCashBenefitCreditReversal (2) | This transaction reverses a previous EBT card Cash Benefit refund transaction. This type should be used when reversing a TSYSHCBenefit credit transaction. |
Data Type
Integer
Config Method (TSYSHCReversal Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* dpaymentssdk_tsyshcreversal_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 (TSYSHCReversal Class)
Interrupts the current action.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int dpaymentssdk_tsyshcreversal_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 (TSYSHCReversal Class)
Clears all properties to their default values.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int dpaymentssdk_tsyshcreversal_reset(void* lpObj);
int Reset();
Remarks
This method clears all properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reverse Method (TSYSHCReversal Class)
Performs a reversal transaction.
Syntax
ANSI (Cross Platform) int Reverse(); Unicode (Windows) INT Reverse();
int dpaymentssdk_tsyshcreversal_reverse(void* lpObj);
int Reverse();
Remarks
This method sends a reversal request to the Vital/TSYS transaction server. If the authorization request was successful, the ResponseCode property will contain "200". Response will contain additional details about the authorization request.
Minimum required properties:
- GenKey
- CardType (required for Visa, Mastercard, Amex, or Discover transactions)
- MerchantId
- RoutingId
- RetrievalNumber
- TransactionAmount
- TransactionType
Note either RetrievalNumber or TransactionNumber may be used to reference the transaction that is to be retrieved, adjusted or voided. If both are supplied, the RetrievalNumber will be used and the TransactionNumber ignored.
In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.
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.)
Error Event (TSYSHCReversal Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(TSYSHCReversalErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } TSYSHCReversalErrorEventParams;
Unicode (Windows) virtual INT FireError(TSYSHCReversalErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } TSYSHCReversalErrorEventParams;
#define EID_TSYSHCREVERSAL_ERROR 1 virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class TSYSHCReversalErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(TSYSHCReversalErrorEventParams *e);
// Or, subclass TSYSHCReversal and override this emitter function. virtual int FireError(TSYSHCReversalErrorEventParams *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 (TSYSHCReversal Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(TSYSHCReversalSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } TSYSHCReversalSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(TSYSHCReversalSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } TSYSHCReversalSSLServerAuthenticationEventParams;
#define EID_TSYSHCREVERSAL_SSLSERVERAUTHENTICATION 2 virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class TSYSHCReversalSSLServerAuthenticationEventParams { 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(TSYSHCReversalSSLServerAuthenticationEventParams *e);
// Or, subclass TSYSHCReversal and override this emitter function. virtual int FireSSLServerAuthentication(TSYSHCReversalSSLServerAuthenticationEventParams *e) {...}
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (TSYSHCReversal Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(TSYSHCReversalSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } TSYSHCReversalSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(TSYSHCReversalSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } TSYSHCReversalSSLStatusEventParams;
#define EID_TSYSHCREVERSAL_SSLSTATUS 3 virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);
class TSYSHCReversalSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(TSYSHCReversalSSLStatusEventParams *e);
// Or, subclass TSYSHCReversal and override this emitter function. virtual int FireSSLStatus(TSYSHCReversalSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (TSYSHCReversal 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.TSYSHCReversal Config Settings
Valid values are:
Code | Description |
P | Pre Authorization |
F | Final Authorization |
U | Undefined Authorization |
Indicator | Description |
EMPTY ("") | Do not send Electronic Commerce Indicator in authorization request (ie: for Retail transactions) |
SPACE (" ") | Not a Mail/Telephone Order Transaction (ie: for retail transactions). |
1 | One Time Occurrence of a Mail/Telephone Order Transaction (use for Direct Marketing). |
2 | Recurring Mail/Telephone Order Transaction. |
3 | Installment Payment of a Mail/Telephone Order Transaction. |
4 | Unknown Classification. |
5 | Secure Electronic Transaction (3-D Secure) and MasterCard SecureCode (UCAF) |
6 | Non-authenticated security transaction at a 3-D Secure capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure. |
7 | Non-authenticated Security Transaction, such as a Channel-Encrypted Transaction (default for CardNotPresent eCommerce transactions). |
8 | Non-secure Electronic Commerce Transaction |
A | In-App Authentication (Discover, Mastercard and Amex) |
R | First recurring SecureCode Phone Order transaction (Mastercard Only) |
T | Single nonrecurring SecureCode Phone Order transaction (Mastercard Only) |
Note: Other values necessary for passing 3D Secure data are CAVV and XID.
Note: Please make sure to send the SPACE (" ") value inside quotes. For Example:
TSYSRetail.Config("ECI=\" \"");
00 | English |
01 | Spanish |
02 | Portuguese |
Reversals
Code | Definition |
2501 | Transaction voided by customer |
2502 | Transaction has not completed (Request timed out or POS device malfunctioned) |
2503 | No confirmation from the point of sale |
2504 | POS partial reversal |
2516 | Premature chip card removal (after online request sent before response received) |
2517 | Chip declined transaction after online issuer approved |
Value | Description |
0 | Dedicated mPOS Terminal with PCI compliant dongle (with or without key pad) |
1 | Off the Shelf Mobile Device |
2 | Dongle with software-based application that supports PIN entry on glass |
3 | Off the Shelf Mobile Device with software-based application that supports PIN entry on glass |
M | Mobile POS Add-On Hardware |
T | Tap on Mobile No Add-On Hardware |
Value | Description |
0 | Not authenticated |
1 | ICC - Offline PIN |
2 | Card acceptance device |
3 | Authorizing agent - Online PIN (MC) |
4 | Merchant/card acceptor - signature |
5 | Other (MC) |
9 | Unknown, data not available |
Value | Description |
0 | No capture capability |
1 | Card capture capability |
9 | Unknown; data not available |
Value | Description |
0 | No electronic authentication capability |
1 | PIN capability |
2 | Electronic signature analysis capability (MC) |
5 | Electronic authentication capability is inoperative (MC) |
6 | Other (MC) |
9 | Unknown; data not available |
Value | Description |
0 | Not authenticated |
1 | PIN |
2 | Electronic signature analysis (MC) |
5 | Manual signature verification |
6 | Other manual verification (driver's license number, etc) |
9 | Unknown, data not available |
F | Suspected fraud (merchant suspicious) |
Q | Cardholder verified by Biometrics |
R | ID verified |
S | Other systematic verification (MC) |
T | Electronic ticket environment (Amex) |
Value | Description |
0 | Cardholder present |
1 | Cardholder not present, unspecified reason |
2 | Cardholder not present, mail transaction |
3 | Cardholder not present, phone transaction |
4 | Cardholder not present, standing (recurring) transaction such as a subscription or Merchant Initiated Transaction (MIT) |
5 | Cardholder not present, electronic commerce |
8 | Cardholder not present, recurrent billing such as a loan or installment |
R | Recurring purchase transaction (original transaction was token-based with valid cryptogram) |
T | Click to Pay (Discover only) |
Value | Description |
0 | Unknown; data not available |
1 | Manual; no POS device |
2 | Magnetic stripe reader capability |
3 | Bar Code / Payment Code read |
4 | Optical Character Reader (OCR) capability (MC) |
5 | Integrated Circuit Card (ICC) capability |
6 | Key entry only capability |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader and key entry capability |
C | Magnetic stripe reader, ICC and key entry capability |
D | Magnetic stripe reader and ICC capability |
E | ICC and key entry capability |
H | ICC reader and contactless capability |
M | PAN auto-entry via contactless chip |
V | Other capability (MC) |
X | Magnetic stripe signature (Amex) |
Value | Description |
0 | Unspecified, data not available |
1 | Manual input, no POS device |
2 | Magnetic stripe reader input |
3 | Bar code/Payment code |
6 | Key entered input |
7 | Merchant initiates a transaction for the cardholder using the payment credential stored on file |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader input, track data captured and passed unaltered |
C | Online chip |
F | Offline chip |
M | PAN auto-entry via contactless Chip (EMV Mode) |
N | Track data read and sent unaltered, chip capable POS device, chip data could not be read |
P | Track data read and sent unaltered, chip capable terminal not having an application that supports the chip card type. |
R | PAN entry via electronic commerce, including remote chip |
S | Electronic commerce, no security, channel encrypted, or SET without cardholder certificate |
V | Manually entered with keyed CID (Amex, JCB Canada) |
W | Swiped transaction with keyed CID (Amex, JCB Canada) |
X | Magnetic stripe signature (Amex, JCB Canada) |
Y | Magnetic stripe signature with keyed CID (Amex, JCB Canada) |
Value | Description |
0 | Unknown; data not available |
1 | None |
2 | Magnetic strip write (MC) |
3 | ICC |
S | Other (MC) |
Value | Description |
0 | Card not present |
1 | Card present |
W | Transponder |
X | Contactless chip |
Z | Digital Wallet [AX] |
Value | Description |
0 | Default value when the service code does not begin with 2 or 6. |
1 | Use this value when service code begins with 2 or 6, and the last read from a chip at the chip capable terminal was successful, or was not a chip transaction, or unknown. |
2 | Use this value when the service code begins with 2 or 6, and last transaction at the chip capable terminal was an unsuccessful chip read. |
Valid values are:
Customer Initiated Transaction (CIT)
Value | Description |
C101 | Credential on File |
C102 | Standing Order (variable amount, fixed frequency) |
C103 | Subscription (fixed amount and fixed frequency) |
C104 | Installment |
Merchant Initiated Transaction (MIT) - Recurring or Installment
Value | Description |
M101 | Unscheduled Credential on File |
M102 | Standing Order (variable amount, fixed frequency) |
M103 | Subscription (fixed amount and fixed frequency) |
M104 | Installment |
Merchant Initiated Transaction (MIT) - Industry Practice
Value | Description |
M205 | Partial Shipment |
M206 | Related/Delayed Charge |
M207 | No show Charge |
M208 | Resubmission |
Note: If CIT/MIT Indicator was present in the original transaction it must be included in a reversal message.
Value | Description |
0 | No POS device used |
1 | On card acceptor premises; attended POS device |
2 | On card acceptor premises; unattended POS device |
3 | Off card acceptor premises; attended |
4 | Off card acceptor premises; unattended |
5 | On cardholder premises; unattended |
6 | Off cardholder premises; unattended (MC) |
9 | Unknown; data not available |
M | Off card acceptor premises; merchant mobile POS environment, including mPOS (Visa, MC) |
P | On card acceptor premises; merchant mobile POS environment, including mPOS (Visa, MC) |
Q | Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA (Visa, MC) |
R | On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA (Visa, MC) |
S | Electronic delivery of product (Amex) |
T | Physical delivery of product (Amex) |
Value | Description |
0 | No PIN capture capability |
1 | Unknown; data not available |
2 | Reserved |
3 | Reserved |
4 | PIN capture capability four characters maximum |
5 | PIN capture capability five characters maximum |
6 | PIN capture capability size characters maximum |
7 | PIN capture capability seven characters maximum |
8 | PIN capture capability eight characters maximum |
9 | PIN capture capability nine characters maximum |
A | PIN capture capability ten characters maximum |
B | PIN capture capability eleven characters maximum |
C | PIN capture capability twelve characters maximum |
Value | Description |
0 | Unknown; data not available |
1 | None |
2 | Printing capability only |
3 | Display capability only |
4 | Printing and display capability |
The tables below provide the valid values for each card brand.
Valid values for Mastercard are:
Value | Description |
0 | Normal request (original presentment) |
1 | Deferred Authorizations |
2 | SecureCode Phone Order |
3 | ATM Installment Inquiry |
4 | Preauthorized request |
5 | Time Based Payment Authorization Request-Brazil domestic transactions |
6 | ATC Update |
8 | Account Status Inquiry Service (ASI) |
9 | Tokenization Request/Notification |
Valid values for Discover are:
Value | Description |
0 | Normal request (original presentment) |
4 | Preauthorized request |
A | Re-authorize for Full Amount |
D | Delayed Card Sale |
E | Resubmission of Card Sale |
G | Transit Aggregated Transaction |
I | Incremental Authorization |
N | No-Show Charge |
P | Partial Shipment |
R | Recurring Payment |
S | Merchant Installment Payment |
T | Third Party Installment Payment |
U | Unscheduled Payment |
V | Issuer Installment Payment |
Note: For Purchase Return Authorization Requests: Value must be 0 (Mastercard and Discover).
The format of this field is 'annnnnnnn' where 'a' is either 'D' for debit or 'C' for credit. 'nnnnnnnn' is the numeric fee amount with the decimal implied. For example: 'D00000150' is a $1.50 transaction fee amount debited to the cardholder's account.
Note: If an amount is only specified, the component will generate the format above by prepending a 'D' and the necessary number of 0's.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (TSYSHCReversal 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.
TSYSHCReversal Errors
501 Data field invalid length. | |
502 Data field invalid format. | |
503 Data field out of range. | |
504 Luhn digit check failed. | |
505 Card date invalid. | |
506 Card expired. | |
507 Card type unknown. | |
509 No gateway specified. | |
511 Invalid data entered. | |
512 Truncated response. | |
513 Invalid response. | |
517 Response length mismatch. | |
518 LRC check failed. | |
519 Corrupt response. | |
520 Response packet empty. | |
521 Response truncated. | |
522 Host disconnected. | |
523 No response from host. | |
524 Server error response. | |
526 Invalid timeout value. | |
527 Vital/TSYS returned an error response. | |
535 Signature verification failed. | |
544 Error building packet. | |
593 Missing or erroneous property value. Cannot send transaction. | |
594 Response received before transmission completed. | |
595 Prematurely disconnected (check MerchantNumber and MerchantBankId). | |
596 Pending responses max number exceeded (Interleaved). | |
597 Pending response timeout (Interleaved). |
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). |