TSYSReversal Component
Properties Methods Events Config Settings Errors
The TSYSReversal component is used to reverse transactions that were previously authorized using the TSYSRETAIL , TSYSECOMMERCE , or TSYSHEALTHCARE components.
Syntax
TibcTSYSReversal
Remarks
Credit card authorizations put a hold on funds on a credit card, until the time at which the transaction is settled or the hold expires. Reversals are similar to voids, but they're online transactions. Voids are off-line. This means that a void will not release the hold on funds at the next batch settlement (usually). Authorization reversals are online transactions, meaning that the hold on funds is immediately removed, and the cardholder may use the funds on the card for other purchases.
This component works for all IndustryTypes and supports Credit, EBT, and Debit card transactions. Both partial and full reversals are supported. When a transaction has been fully reversed (SettlementAmount is "0") the original transaction must not be included in the batch settlement. However, if the transaction has been only partially reversed, the original detail record must be updated with the new settlement amount. The SettlementAmount property in the detail record should be set to the SettlementAmount sent in the reversal transaction. The AuthorizedAmount in the detail record should contain the transaction amount authorized from the original authorization request message. This value is retrieved from the detail aggregate, however you may set it using the TSYSDetailRecord's AuthorizedAmount property. You must also set the PartiallyReversed configuration setting to True. For instance:
TSYSRetail.TransactionAmount = "10000"; // $100.00
TSYSRetail.Authorize();
TSYSReversal.ParseAggregate(TSYSRetail.GetDetailAggregate());
TSYSReversal.ReversalCode = rcCustomerDirected;
TSYSReversal.ReversalType = rtPreSettlement;
TSYSReversal.SettlementAmount = "5000"; // $50.00
TSYSReversal.Reverse();
TSYSDetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate());
TSYSDetailRecord.AuthorizedAmount = "10000"; // Original authorized amount
TSYSDetailRecord.SettlementAmount = "5000"; // Amount you wish to settle (need not be equal to AuthorizedAmount)
TSYSDetailRecord.Config("PartiallyReversed=True");
TSYSSettle.DetailRecords.Add(new TSYSRecordType(TSYSDetailRecord.GetDetailAggregate()));
So long as you pass aggregates around, the TSYSDetailRecord's TotalAuthorizedAmount will still reflect the originally authorized amount. You may change this using the TSYSDetailRecord's TotalAuthorizedAmount property.
When the component receives a response from the Vital/TSYS servers, the result of the reversal will be displayed in several Response properties. The ResponseCode indicates whether the reversal was approved, and the remaining response properties should exactly match the response from the original authorization.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AgentBankNumber | Identifies a specific agent entity of the member bank or processor. |
AgentChainNumber | Identifies a specific chain of an agent organization. |
ApprovalCode | The Response ApprovalCode of the transaction being reversed. |
BatchNumber | The batch number that this transaction will be included in. |
CardType | Type of credit card being used in this transaction. |
CardCVVData | Three digit security code on back of card (optional). |
CardCVVPresence | Indicates the presence of the card verification value. |
CardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
CardExpMonth | Expiration month of the credit card specified in Number . |
CardExpYear | Expiration year of the credit card specified in Number . |
CardIsEncrypted | Determines whether data set to the Number or MagneticStripe properties is validated. |
CardMagneticStripe | Track data read off of the card's magnetic stripe. |
CardNumber | Customer's credit card number for the transaction. |
CardholderId | The CardholderId code for this reversal. |
CashBackAmount | Amount returned to the customer in cash. |
IndustryType | Code which indicates the industry the merchant is engaged in. |
MerchantBankId | The number which identifies the merchant's bank or processor. |
MerchantCategoryCode | Classifies a merchant by the type of store. |
MerchantCity | Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. |
MerchantCountryCode | Identifies the country where the merchant is located. |
MerchantCurrencyCode | Identifies the type of currency used by the merchant. |
MerchantLanguage | Designates the language that response messages will be returned in. |
MerchantName | Name of the merchant. |
MerchantNumber | A unique number used to identify the merchant within the VisaNet system. |
MerchantPhone | Merchant's phone number. |
MerchantServicePhone | Merchant's customer service number. |
MerchantState | State or province that the merchant is located in. |
MerchantStoreNumber | Used to identify a specific merchant's store within the VisaNet system. |
MerchantStreetAddress | Merchant's street address. |
MerchantTerminalNumber | Used to identify a unique terminal within a merchant location. |
MerchantTimeZone | Specifies the GMT offset used to calculate the local time within the VisaNet system. |
MerchantZip | Zip code where the merchant that initiated this transaction is located. |
MerchantABANumber | Merchant's routing number. |
MerchantSettlementAgent | Merchant's settling agent. |
NetworkId | Identification code of the network on which the transaction was authorized. |
ReimbursementAttribute | Indicates the type of fee applicable to this transaction. |
ResponseApprovalCode | Contains an authorization code when a transaction has been approved. |
ResponseAuthorizedAmount | Amount actually used from the card (used when supporting partial redemptions). |
ResponseAuthSource | Indicates the source of the authorization code stored in ApprovalCode . |
ResponseAVSResult | Contains the Address Verification System result code. |
ResponseCardLevel | This property contains a two-character code created by Visa during the authorization process. |
ResponseCode | Indicates the status of the authorization request. |
ResponseCommercialCardType | Response property that indicates whether the card is a commercial card. |
ResponseCVVResult | Contains the returned CVV result code if it was requested. |
ResponseRetrievalNumber | This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement. |
ResponseReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
ResponseText | Text information that describes each response code. |
ResponseTransactionDate | Local transaction date returned from the server in MMddyy format. |
ResponseTransactionId | Contains the Transaction Identifier or MasterCard Reference Number. |
ResponseTransactionNumber | Check this property against the original Transaction Number. |
ResponseTransactionTime | Local transaction time returned from the server in HHmmss format. |
ResponseValidationCode | This optional property contains information generated by the card issuer. |
RetrievalNumber | The Response RetrievalNumber of the transaction being reversed. |
ReturnedACI | The Response ReturnedACI of the transaction being reversed. |
ReversalCode | This code can be present in the reversal request for MasterCard transactions to signify the reason for the reversal. |
ReversalType | Specifies the type of reversal to process. |
SettlementAmount | The new Settlement Amount for this transaction. |
SharingGroup | List of Debit and EBT networks that the merchant supports. |
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 component. |
TotalAuthorizedAmount | The amount originally authorized. |
TraceAuditNumber | System Trace Audit Number returned for Debit and EBT transactions. |
TransactionDate | The Response TransactionDate of the transaction being reversed. |
TransactionId | The Response TransactionId of the transaction being reversed. |
TransactionNumber | Sequence number of this transaction. |
TransactionTime | The Response TransactionTime of the transaction being reversed. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Interrupt | Interrupts the current action. |
ParseAggregate | Parses the aggregate returned from another component's GetDetailAggregate method. |
Reset | Clears all properties to their default values. |
Reverse | Reverses a previously authorized transaction. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Connected | Fired immediately after a connection completes (or fails). |
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
Disconnected | Fired when a connection is closed. |
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AccountDataSource | Identifies the source of the customer card data entered. |
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
CanadaDomesticIndicator | Canada Domestic Indicator. |
CITMITIndicator | CIT/MIT Indicator. |
GatewayID | A unique value to identify a Gateway or Aggregator. |
GenKey | A randomly generated string of alphanumeric characters identifying the terminal. |
HeartlandDeviceId | Specifies a device ID to uniquely identify each terminal (card data entry device). |
HeartlandEncryptionMode | Specifies the encryption mode to use in Heartland transactions. |
MessageReasonCode | The reversal message reason code used to identify why the reversal is being made. |
Port | The port to which transactions are posted. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
Processor | Specifies the Processor you are connecting to. |
ResponseTokenPAN | Card Brand Token PAN Last 4 Digits returned in the response. |
ResponseTransactionIntegrityClass | A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class. |
Retry | Set this to retry a failed Bill Payment Reversal. |
Server | The server to which transactions are posted. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
TokenRequestorID | Card brand Token Requestor ID assigned by the token service provider. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component 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. |
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 component 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. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
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. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AgentBankNumber Property (TSYSReversal Component)
Identifies a specific agent entity of the member bank or processor.
Syntax
__property String AgentBankNumber = { read=FAgentBankNumber, write=FSetAgentBankNumber };
Default Value
""
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purposes of identifying a specific agent entity of the member bank or processor.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
String
AgentChainNumber Property (TSYSReversal Component)
Identifies a specific chain of an agent organization.
Syntax
__property String AgentChainNumber = { read=FAgentChainNumber, write=FSetAgentChainNumber };
Default Value
""
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purpose of identifying a specific chain of an agent organization.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
String
ApprovalCode Property (TSYSReversal Component)
The Response ApprovalCode of the transaction being reversed.
Syntax
__property String ApprovalCode = { read=FApprovalCode, write=FSetApprovalCode };
Default Value
""
Remarks
This must exactly match the ResponseApprovalCode from the original authorization.
Data Type
String
BatchNumber Property (TSYSReversal Component)
The batch number that this transaction will be included in.
Syntax
__property int BatchNumber = { read=FBatchNumber, write=FSetBatchNumber };
Default Value
1
Remarks
Unlike regular credit card transactions, Debit transactions require that the Batch Number be sent in the authorization request. This number should be the same number you set to the TSYSDebit or TSYSBenefit component's BatchNumber property during the authorization.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
Integer
CardType Property (TSYSReversal Component)
Type of credit card being used in this transaction.
Syntax
__property TibcTSYSReversalCardTypes CardType = { read=FCardType, write=FSetCardType };
enum TibcTSYSReversalCardTypes { ctUnknown=0, ctVisa=1, ctMasterCard=2, ctAMEX=3, ctDiscover=4, ctDiners=5, ctJCB=6, ctVisaElectron=7, ctMaestro=8, ctLaser=10 };
Default Value
ctUnknown
Remarks
Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.
ctUnknown (0) | Invalid or unknown prefix, card type not known. |
ctVisa (1) | Visa or Delta Card. |
ctMasterCard (2) | MasterCard. |
ctAMEX (3) | American Express Card. |
ctDiscover (4) | Discover Card. |
ctDiners (5) | Diners Club or Carte Blanche Card. |
ctJCB (6) | JCB Card. |
ctVisaElectron (7) | Visa Electron Card (runs as a Visa for most gateways) |
ctMaestro (8) | Maestro Card |
ctLaser (10) | Laser Card (Ireland) |
This property is not available at design time.
Data Type
Integer
CardCVVData Property (TSYSReversal Component)
Three digit security code on back of card (optional).
Syntax
__property String CardCVVData = { read=FCardCVVData, write=FSetCardCVVData };
Default Value
""
Remarks
Three digit security code on back of card (optional).
This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.
Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.
Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.
This property is not available at design time.
Data Type
String
CardCVVPresence Property (TSYSReversal Component)
Indicates the presence of the card verification value.
Syntax
__property TibcTSYSReversalCardCVVPresences CardCVVPresence = { read=FCardCVVPresence, write=FSetCardCVVPresence };
enum TibcTSYSReversalCardCVVPresences { cvpNotProvided=0, cvpProvided=1, cvpIllegible=2, cvpNotOnCard=3 };
Default Value
cvpNotProvided
Remarks
Indicates the presence of the card verification value.
This property is used to indicate the presence of CardCVVData.
The component will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.
Available values are:
- cvpNotProvided (0)
- cvpProvided (1)
- cvpIllegible (2)
- cvpNotOnCard (3)
This property is not available at design time.
Data Type
Integer
CardEntryDataSource Property (TSYSReversal Component)
This property contains a 1-character code identifying the source of the customer data.
Syntax
__property TibcTSYSReversalCardEntryDataSources CardEntryDataSource = { read=FCardEntryDataSource, write=FSetCardEntryDataSource };
enum TibcTSYSReversalCardEntryDataSources { edsTrack1=0, edsTrack2=1, edsManualEntryTrack1Capable=2, edsManualEntryTrack2Capable=3, edsManualEntryNoCardReader=4, edsTrack1Contactless=5, edsTrack2Contactless=6, edsManualEntryContactlessCapable=7, edsIVR=8, edsKiosk=9 };
Default Value
edsTrack1
Remarks
This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.
edsTrack1 (0) | Full Magnetic stripe read and transmit, Track 1. |
edsTrack2 (1) | Full magnetic stripe read and transmit, Track 2. |
edsManualEntryTrack1Capable (2) | Manually keyed, Track 1 capable. |
edsManualEntryTrack2Capable (3) | Manually keyed, Track 2 capable. |
edsManualEntryNoCardReader (4) | Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions). |
edsTrack1Contactless (5) | Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsTrack2Contactless (6) | Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsManualEntryContactlessCapable (7) | Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only). |
edsIVR (8) | Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (CardNumber, CardExpMonth, and CardExpYear are sent). |
edsKiosk (9) | Automated kiosk transaction. Track1 or Track2 data must be sent in CardMagneticStripe, the transaction cannot be manually entered. |
Below is a list of processors and their support EntryDataSource values:
FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk
FDMSOmaha - All EntryDataSources applicable
FDMS Rapid Connect - All EntryDataSources applicable
Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk
PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable
TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable
TSYSHC - Values are based on Industry type.
TSYSHCBenefit | edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable |
TSYSHCECommerce | edsManualEntryNoCardReader |
TSYSHCRetail | edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable |
This property is not available at design time.
Data Type
Integer
CardExpMonth Property (TSYSReversal Component)
Expiration month of the credit card specified in Number .
Syntax
__property int CardExpMonth = { read=FCardExpMonth, write=FSetCardExpMonth };
Default Value
1
Remarks
Expiration month of the credit card specified in CardNumber.
This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.
This property is not available at design time.
Data Type
Integer
CardExpYear Property (TSYSReversal Component)
Expiration year of the credit card specified in Number .
Syntax
__property int CardExpYear = { read=FCardExpYear, write=FSetCardExpYear };
Default Value
2000
Remarks
Expiration year of the credit card specified in CardNumber.
This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.
This property is not available at design time.
Data Type
Integer
CardIsEncrypted Property (TSYSReversal Component)
Determines whether data set to the Number or MagneticStripe properties is validated.
Syntax
__property bool CardIsEncrypted = { read=FCardIsEncrypted, write=FSetCardIsEncrypted };
Default Value
false
Remarks
Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.
By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.
This property is not available at design time.
Data Type
Boolean
CardMagneticStripe Property (TSYSReversal Component)
Track data read off of the card's magnetic stripe.
Syntax
__property String CardMagneticStripe = { read=FCardMagneticStripe, write=FSetCardMagneticStripe };
Default Value
""
Remarks
Track data read off of the card's magnetic stripe.
If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.
The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"
component.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
component.CardEntryDataSource = edsTrack1
or
component.CardMagneticStripe = "4788250000028291=05121015432112345678"
component.CardEntryDataSource = edsTrack2
Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.
This property is not available at design time.
Data Type
String
CardNumber Property (TSYSReversal Component)
Customer's credit card number for the transaction.
Syntax
__property String CardNumber = { read=FCardNumber, write=FSetCardNumber };
Default Value
""
Remarks
Customer's credit card number for the transaction.
If you're sending the transaction with CardMagneticStripe data, this property should be left empty.
This property is not available at design time.
Data Type
String
CardholderId Property (TSYSReversal Component)
The CardholderId code for this reversal.
Syntax
__property String CardholderId = { read=FCardholderId, write=FSetCardholderId };
Default Value
"@"
Remarks
This 1-character property contains a code that specifies the method used to verify the identity of the cardholder. The value may be used in conjunction with AVS and ACI indicators. The following table lists all of the supported cardholder identification codes, but please note that some codes are Direct Marketing-specific and some are Retail-specific.
M | Address Verification Data or CPS/Card Present, unable to read magnetic stripe. |
N | Address Verification Data, CPS/Card Not Present, or Electronic Commerce |
Z | Cardholder signature - Terminal has a PIN pad |
@ | Cardholder signature - No PIN pad available (default for Retail transactions) |
NOTE: The CardholderId for reversals is applicable to the reversal transaction itself, NOT to the transaction being reversed. Generally the card will be present and the cardholder will sign the receipt, so for most cases this should be "@".
Data Type
String
CashBackAmount Property (TSYSReversal Component)
Amount returned to the customer in cash.
Syntax
__property String CashBackAmount = { read=FCashBackAmount, write=FSetCashBackAmount };
Default Value
""
Remarks
The amount of CashBack specified in the authorization request. This property should be the same number you set to the TSYSDebit or TSYSBenefit component's CashBackAmount property during the authorization.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
String
IndustryType Property (TSYSReversal Component)
Code which indicates the industry the merchant is engaged in.
Syntax
__property TibcTSYSReversalIndustryTypes IndustryType = { read=FIndustryType, write=FSetIndustryType };
enum TibcTSYSReversalIndustryTypes { sitUnknown=0, sitRetail=1, sitRestaurant=2, sitGroceryStore=3, sitDirectMarketing=4, sitHotel=5, sitAutoRental=6, sitPassengerTransport=7 };
Default Value
sitRetail
Remarks
This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this component.
sitUnknown (0) | Unknown or unsure. |
sitRetail (1) | Retail store. |
sitRestaurant (2) | Food / Restaurant. |
sitGroceryStore (3) | Grocery store or supermarket. |
sitDirectMarketing (4) | eCommerce or Direct Marketing |
sitHotel (5) | Hotel / Lodging |
sitAutoRental (6) | Auto Rental |
sitPassengerTransport (7) | Passenger Transport |
Note: American Express cards are NOT currently supported in the sitAutoRental industry.
Data Type
Integer
MerchantBankId Property (TSYSReversal Component)
The number which identifies the merchant's bank or processor.
Syntax
__property String MerchantBankId = { read=FMerchantBankId, write=FSetMerchantBankId };
Default Value
""
Remarks
The number which identifies the merchant's bank or processor.
This property contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This property may not remain zero-filled.
Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
Data Type
String
MerchantCategoryCode Property (TSYSReversal Component)
Classifies a merchant by the type of store.
Syntax
__property String MerchantCategoryCode = { read=FMerchantCategoryCode, write=FSetMerchantCategoryCode };
Default Value
""
Remarks
Classifies a merchant by the type of store.
This four digit property contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
Data Type
String
MerchantCity Property (TSYSReversal Component)
Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
Syntax
__property String MerchantCity = { read=FMerchantCity, write=FSetMerchantCity };
Default Value
""
Remarks
Merchant's City
For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. This is an optional property. However if it is specified, the MerchantName and MerchantState must also be specified.
The first character of this property may not be a space and must contain the same data used in the batch settlement.
Note that this property is ignored for Direct Marketing and E-Commerce transactions. MerchantServicePhone is used for those industries instead of MerchantCity.
This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.
Data Type
String
MerchantCountryCode Property (TSYSReversal Component)
Identifies the country where the merchant is located.
Syntax
__property String MerchantCountryCode = { read=FMerchantCountryCode, write=FSetMerchantCountryCode };
Default Value
"840"
Remarks
Identifies the country where the merchant is located.
This property contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".
Data Type
String
MerchantCurrencyCode Property (TSYSReversal Component)
Identifies the type of currency used by the merchant.
Syntax
__property String MerchantCurrencyCode = { read=FMerchantCurrencyCode, write=FSetMerchantCurrencyCode };
Default Value
"840"
Remarks
Identifies the type of currency used by the merchant.
This property contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".
Data Type
String
MerchantLanguage Property (TSYSReversal Component)
Designates the language that response messages will be returned in.
Syntax
__property String MerchantLanguage = { read=FMerchantLanguage, write=FSetMerchantLanguage };
Default Value
"00"
Remarks
Designates the language that response messages will be returned in.
This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.
Indicator | Language |
00 | English. |
01 | Spanish. |
02 | Portuguese. |
03 | Reserved for Irish. |
04 | Reserved for French. |
05 | Reserved for German. |
06 | Reserved for Italian. |
07 | Reserved for Dutch. |
Data Type
String
MerchantName Property (TSYSReversal Component)
Name of the merchant.
Syntax
__property String MerchantName = { read=FMerchantName, write=FSetMerchantName };
Default Value
""
Remarks
Name of the merchant.
This 25 character property contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this property may not be a space. This property must contain the same value in both authorization and batch settlement.
This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.
This property may contain alphanumeric and punctuation characters. The maximum length of this property is 25 characters.
Data Type
String
MerchantNumber Property (TSYSReversal Component)
A unique number used to identify the merchant within the VisaNet system.
Syntax
__property String MerchantNumber = { read=FMerchantNumber, write=FSetMerchantNumber };
Default Value
""
Remarks
A unique number used to identify the merchant within the VisaNet system.
This 12 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This property is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.
Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
Data Type
String
MerchantPhone Property (TSYSReversal Component)
Merchant's phone number.
Syntax
__property String MerchantPhone = { read=FMerchantPhone, write=FSetMerchantPhone };
Default Value
""
Remarks
Merchant's phone number.
This property contains the Merchant's business phone number. This can be the same as the customer service phone number.
Data Type
String
MerchantServicePhone Property (TSYSReversal Component)
Merchant's customer service number.
Syntax
__property String MerchantServicePhone = { read=FMerchantServicePhone, write=FSetMerchantServicePhone };
Default Value
""
Remarks
Merchant's customer service number.
This property contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.
This property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.
Data Type
String
MerchantState Property (TSYSReversal Component)
State or province that the merchant is located in.
Syntax
__property String MerchantState = { read=FMerchantState, write=FSetMerchantState };
Default Value
""
Remarks
State or province that the merchant is located in.
This two character property contains the merchant state or province provided by the signing member or processor. This property must contain the same data used in the batch settlement.
This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.
Data Type
String
MerchantStoreNumber Property (TSYSReversal Component)
Used to identify a specific merchant's store within the VisaNet system.
Syntax
__property String MerchantStoreNumber = { read=FMerchantStoreNumber, write=FSetMerchantStoreNumber };
Default Value
""
Remarks
Used to identify a specific merchant's store within the VisaNet system.
This four digit property contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This property must be right-justified and zero-filled.
Data Type
String
MerchantStreetAddress Property (TSYSReversal Component)
Merchant's street address.
Syntax
__property String MerchantStreetAddress = { read=FMerchantStreetAddress, write=FSetMerchantStreetAddress };
Default Value
""
Remarks
Merchant's street address.
This 25 character property contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.
Data Type
String
MerchantTerminalNumber Property (TSYSReversal Component)
Used to identify a unique terminal within a merchant location.
Syntax
__property String MerchantTerminalNumber = { read=FMerchantTerminalNumber, write=FSetMerchantTerminalNumber };
Default Value
""
Remarks
Used to identify a unique terminal within a merchant location.
This four digit property contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this property may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This property must be right-justified and zero-filled.
Data Type
String
MerchantTimeZone Property (TSYSReversal Component)
Specifies the GMT offset used to calculate the local time within the VisaNet system.
Syntax
__property String MerchantTimeZone = { read=FMerchantTimeZone, write=FSetMerchantTimeZone };
Default Value
"705"
Remarks
Specifies the GMT offset used to calculate the local time within the VisaNet system.
This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.
Byte #1:
Value | Meaning |
0 | Positive offset, in hours, ahead of GMT. |
1 | Negative offset, in hours, behind GMT. |
2 | Positive offset, in 15 minute increments, ahead of GMT. |
3 | Negative offset, in 15 minute increments, behind GMT. |
4 | Positive offset, in 15 minute increments, ahead of GMT, in cities participating in daylight savings. |
5 | Negative offset, in 15 minute increments, behind GMT, in cities participating in daylight savings. |
6 | Positive offset, in hours, ahead of GMT, in cities participating in daylight savings. |
7 | Negative offset, in hours, behind GMT, in cities participating in daylight savings. |
8-9 | RESERVED. |
If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.
Data Type
String
MerchantZip Property (TSYSReversal Component)
Zip code where the merchant that initiated this transaction is located.
Syntax
__property String MerchantZip = { read=FMerchantZip, write=FSetMerchantZip };
Default Value
""
Remarks
Zip code where the merchant that initiated this transaction is located.
This property contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this property will be assigned by the signing member or processor.
This property is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.
Data Type
String
MerchantABANumber Property (TSYSReversal Component)
Merchant's routing number.
Syntax
__property String MerchantABANumber = { read=FMerchantABANumber, write=FSetMerchantABANumber };
Default Value
""
Remarks
This property identifies the merchant to a direct debit switch, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 9 digits in length.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
String
MerchantSettlementAgent Property (TSYSReversal Component)
Merchant's settling agent.
Syntax
__property String MerchantSettlementAgent = { read=FMerchantSettlementAgent, write=FSetMerchantSettlementAgent };
Default Value
""
Remarks
This property identifies the merchant settling agent, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 4 digits in length.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
String
NetworkId Property (TSYSReversal Component)
Identification code of the network on which the transaction was authorized.
Syntax
__property String NetworkId = { read=FNetworkId, write=FSetNetworkId };
Default Value
""
Remarks
This property indicates the network through which the transaction was authorized. This value should be set to the NetworkId returned in the response of the original TSYSDebit or TSYSBenefit authorization.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
String
ReimbursementAttribute Property (TSYSReversal Component)
Indicates the type of fee applicable to this transaction.
Syntax
__property TibcTSYSReversalReimbursementAttributes ReimbursementAttribute = { read=FReimbursementAttribute, write=FSetReimbursementAttribute };
enum TibcTSYSReversalReimbursementAttributes { raStandardRetail=0, raQualifiedGrocery=1, raPreExistingRetail=2, raPreExistingGrocery=3, raNonDebit=4, raTaxExempt=5 };
Default Value
raStandardRetail
Remarks
This property contains the reimbursement attribute assigned by the signing member or processor. This property designates the Reimbursement Fee applicable to a transaction. This value should be set to the value of the ReimbursementAttribute of the original TSYSDebit authorization. The following values are valid:
raStandardRetail (0) | Standard INTERLINK Retail Merchant. |
raQualifiedGrocery (1) | Qualified INTERLINK Supermarket/Grocery Merchant. |
raPreExistingRetail (2) | Pre-existing Qualified INTERLINK Retail Merchant. |
raPreExistingGrocery (3) | Pre-existing Qualified INTERLINK Supermarket/Grocery Merchant. |
raNonDebit (4) | EBT, non-debit, or Non-INTERLINK debit. |
raTaxExempt (5) | Tax exempt organizations. |
This field is only used for Debit and Benefit/EBT reversals.
Data Type
Integer
ResponseApprovalCode Property (TSYSReversal Component)
Contains an authorization code when a transaction has been approved.
Syntax
__property String ResponseApprovalCode = { read=FResponseApprovalCode };
Default Value
""
Remarks
Contains an authorization code when a transaction has been approved.
This six character property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction has not been approved, then the contents of the property should be ignored. The ResponseApprovalCode must be stored and submitted in the settlement data capture record.
This property is read-only and not available at design time.
Data Type
String
ResponseAuthorizedAmount Property (TSYSReversal Component)
Amount actually used from the card (used when supporting partial redemptions).
Syntax
__property String ResponseAuthorizedAmount = { read=FResponseAuthorizedAmount };
Default Value
""
Remarks
Amount actually used from the card (used when supporting partial redemptions).
The ResponseAuthorizedAmount represents the actual approved transaction amount when a transaction request is received from a client using the PartialRedemption option. If PartialAuthorization is set to True, then ResponseAuthorizedAmount will be the amount of the TransactionAmount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.
For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the PartialAuthorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the ResponseAuthorizedAmount will represent the approved amount of $7.50.In this case, the ResponseCode will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the ResponseAuthorizedAmount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the TransactionAmount) then this property will be "0" or "".
If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialAuthorization.
This property is read-only.
Data Type
String
ResponseAuthSource Property (TSYSReversal Component)
Indicates the source of the authorization code stored in ApprovalCode .
Syntax
__property String ResponseAuthSource = { read=FResponseAuthSource };
Default Value
""
Remarks
Indicates the source of the authorization code stored in ResponseApprovalCode.
This property contains a one character code indicating the source of the ResponseApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes are:
Code | Description |
6 | Off-line approval: POS device generated. |
7 | Acquirer approval. |
9 | Use for non-authorized transactions; such as credit card credits |
B | Response provided by Visa Transaction Advisor Service. |
E | Off-line approval: authorization code manually keyed. |
F | CAFIS-generated response: Post-Auth.* |
G | Issuer Approval: Post-Auth.* |
H | Exceeds acquirer settlement risk exposure cap. |
N | No authorization required: Below floor limit |
L | Late clearing - authorization previously obtained (clearing beyond 30 days) |
V | Authorization obtained via VisaNet (Issuer or STIP response) |
Space | Default value, if acquirer cannot define it (MC, D, AX) |
This property is read-only and not available at design time.
Data Type
String
ResponseAVSResult Property (TSYSReversal Component)
Contains the Address Verification System result code.
Syntax
__property String ResponseAVSResult = { read=FResponseAVSResult };
Default Value
""
Remarks
Contains the Address Verification System result code.
This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:
Code | Description |
0 | Approved/Declined - Address verification was not requested or it was requested but the transaction was declined (Visa, MC, Amex, Discover). |
A | Address Match - CustomerAddress matches, CustomerZip does not, or the request does not include the CustomerZip (Visa, Amex, Discover). |
I* | Ver Unavailable - Address information not verified (Discover). |
N | No match - Transaction contained postal/ZIP code only, or street address only, or postal code and street address. Also used when transaction requests AVS but sends no AVS data (Visa, MC, Amex, Discover). |
R | Retry - System unable to process (Visa, MC, Amex, Discover). |
S | Serv Unavailable - Service not supported (MC, Amex, Discover). |
U | Ver Unavailable - No data from Issuer/Authorization platform (Visa, MC, Amex, Discover). |
W | Zip Match - Nine character CustomerZip matches, CustomerAddress does not (MC, Discover). |
X | Exact Match - Nine character CustomerZip and CustomerAddress match (MC, Discover). |
Y | Exact Match - CustomerZip and CustomerAddress match (Visa, MC, Amex, Discover). |
Z | Zip Match - CustomerZip matches; CustomerAddress does not match or street address not included in the request (Visa, MC, Amex, Discover). |
1 | APPROVAL - Cardholder name and ZIP match (Amex only). |
2 | APPROVAL - Cardholder name, address, and ZIP match (Amex only). |
3 | APPROVAL - Cardholder name, address match (Amex only). |
4 | APPROVAL - Cardholder name matches (Amex only). |
5 | APPROVAL - Cardholder name incorrect, ZIP matches (Amex only). |
6 | APPROVAL - Cardholder name incorrect, address and ZIP match (Amex only). |
7 | APPROVAL - Cardholder name incorrect, address matches (Amex only). |
8 | NO MATCH - Cardholder name, address, and ZIP do not match (Amex only). |
*AVS Result Code for International addresses only
This property is read-only and not available at design time.
Data Type
String
ResponseCardLevel Property (TSYSReversal Component)
This property contains a two-character code created by Visa during the authorization process.
Syntax
__property String ResponseCardLevel = { read=FResponseCardLevel };
Default Value
""
Remarks
This property contains a two-character code created by Visa during the authorization process.
The current list of possible return values can be found in the table of contents.
This property is read-only and not available at design time.
Data Type
String
ResponseCode Property (TSYSReversal Component)
Indicates the status of the authorization request.
Syntax
__property String ResponseCode = { read=FResponseCode };
Default Value
""
Remarks
Indicates the status of the authorization request.
This property contains a two character response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents an approval. A response code of "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".
A list of valid result ResponseCodes are listed in the table of contents.
This property is read-only and not available at design time.
Data Type
String
ResponseCommercialCardType Property (TSYSReversal Component)
Response property that indicates whether the card is a commercial card.
Syntax
__property TibcTSYSReversalResponseCommercialCardTypes ResponseCommercialCardType = { read=FResponseCommercialCardType };
enum TibcTSYSReversalResponseCommercialCardTypes { tccNotCommercial=0, tccBusinessCard=1, tccVisaCommerce=2, tccCorporateCard=3, tccPurchaseCard=4 };
Default Value
tccNotCommercial
Remarks
Response property that indicates whether the card is a commercial card.
If you wish to support Corporate Purchasing Cards with Level II or Level III data, you should inspect the value of this property after a successful authorization. If the Vital/TSYS host indicates that the authorized card is a commercial card, you may use the TSYSLevel2 or TSYSLevel3 components to add the extra data required during settlement.
Possible values for this property include:
tccNotCommercial (0) | Not a commercial card. You must not send Level II or Level III data in the settlement. |
tccBusinessCard (1) | Business Card |
tccVisaCommerce (2) | Visa Commerce (Reserved for future use) |
tccCorporateCard (3) | Corporate Card |
tccPurchaseCard (4) | Purchasing Card |
This property is only valid after a successful authorization request and response.
This property is read-only and not available at design time.
Data Type
Integer
ResponseCVVResult Property (TSYSReversal Component)
Contains the returned CVV result code if it was requested.
Syntax
__property String ResponseCVVResult = { read=FResponseCVVResult };
Default Value
""
Remarks
Contains the returned CVV result code if it was requested.
If a CVV value was sent in the authorization request, then this one character property will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CVV data is included in the authorization. Instead, an AMEX transaction will be declined if the CVV value does not match, with an ResponseText indicating such. The following is a list of current result codes:
M | CVV2 match. |
N | CVV2 no match. |
P | Not processed. |
S | Merchant has indicated that CVV2 is not present on card. |
U | Issuer not certified and/or has not provided Visa encryption keys. |
This property is read-only and not available at design time.
Data Type
String
ResponseRetrievalNumber Property (TSYSReversal Component)
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
Syntax
__property String ResponseRetrievalNumber = { read=FResponseRetrievalNumber };
Default Value
""
Remarks
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
This property contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.
This property is read-only and not available at design time.
Data Type
String
ResponseReturnedACI Property (TSYSReversal Component)
Returned Authorization Characteristics Indicator contains CPS qualification status.
Syntax
__property String ResponseReturnedACI = { read=FResponseReturnedACI };
Default Value
""
Remarks
Returned Authorization Characteristics Indicator contains CPS qualification status.
This one character property contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this property and submit it in the batch settlement. The POS system should not interpret any relationship between this property and the presence of data in either the ResponseTransactionId or ResponseValidationCode properties.
This property is read-only and not available at design time.
Data Type
String
ResponseText Property (TSYSReversal Component)
Text information that describes each response code.
Syntax
__property String ResponseText = { read=FResponseText };
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 (TSYSReversal Component)
Local transaction date returned from the server in MMddyy format.
Syntax
__property String ResponseTransactionDate = { read=FResponseTransactionDate };
Default Value
""
Remarks
Local transaction date returned from the server in MMddyy format.
This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionId Property (TSYSReversal Component)
Contains the Transaction Identifier or MasterCard Reference Number.
Syntax
__property String ResponseTransactionId = { read=FResponseTransactionId };
Default Value
""
Remarks
Contains the Transaction Identifier or MasterCard Reference Number.
This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionNumber Property (TSYSReversal Component)
Check this property against the original Transaction Number.
Syntax
__property String ResponseTransactionNumber = { read=FResponseTransactionNumber };
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 (TSYSReversal Component)
Local transaction time returned from the server in HHmmss format.
Syntax
__property String ResponseTransactionTime = { read=FResponseTransactionTime };
Default Value
""
Remarks
Local transaction time returned from the server in HHmmss format.
This six digit property contains the Local Transaction Time returned by the authorizing system. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseValidationCode Property (TSYSReversal Component)
This optional property contains information generated by the card issuer.
Syntax
__property String ResponseValidationCode = { read=FResponseValidationCode };
Default Value
""
Remarks
This optional property contains information generated by the card issuer.
This optional four character property contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property should be recorded and submitted as part of a Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
RetrievalNumber Property (TSYSReversal Component)
The Response RetrievalNumber of the transaction being reversed.
Syntax
__property String RetrievalNumber = { read=FRetrievalNumber, write=FSetRetrievalNumber };
Default Value
""
Remarks
This property contains a 12-character value reflecting the transaction Retrieval Reference Number of the transaction being reversed.
Data Type
String
ReturnedACI Property (TSYSReversal Component)
The Response ReturnedACI of the transaction being reversed.
Syntax
__property String ReturnedACI = { read=FReturnedACI, write=FSetReturnedACI };
Default Value
""
Remarks
The length of this property is one character.
Data Type
String
ReversalCode Property (TSYSReversal Component)
This code can be present in the reversal request for MasterCard transactions to signify the reason for the reversal.
Syntax
__property TibcTSYSReversalReversalCodes ReversalCode = { read=FReversalCode, write=FSetReversalCode };
enum TibcTSYSReversalReversalCodes { rcNotSpecified=0, rcCustomerDirected=1, rcPartialReversal=2, rcCNPSuspectFraud=3 };
Default Value
rcNotSpecified
Remarks
rcNotSpecified (0) | Do not send the ReversalCode in the request. |
rcCustomerDirected (1) | Customer directed reversal. |
rcPartialReversal (2) | Partial reversal. |
rcCNPSuspectFraud (3) | Card not present. Suspect Fraud. |
Data Type
Integer
ReversalType Property (TSYSReversal Component)
Specifies the type of reversal to process.
Syntax
__property TibcTSYSReversalReversalTypes ReversalType = { read=FReversalType, write=FSetReversalType };
enum TibcTSYSReversalReversalTypes { rtPreSettlement=0, rtDebitPurchase=1, rtDebitCredit=2, rtDebitTimeout=3, rtTimeout=4, rtCreditAuthorization=5 };
Default Value
rtPreSettlement
Remarks
rtPreSettlement (0) | Online Authorization Reversal - Utilized in Direct Marketing, Hotel, and Auto Rental industries where authorization amounts are frequently manipulated. |
rtDebitPurchase (1) | Purchase Reversal for Debit and Benefit/EBT transactions. - Utilized in Retail industries. |
rtDebitCredit (2) | Credit Reversal for Debit and Benefit/EBT transactions. - Utilized in Retail industries. |
rtDebitTimeout (3) | Time Out Reversal for Debit and Benefit/EBT transactions. This reversal type is used to reverse a debit or Benefit/EBT transaction when the POS application times out waiting for a response from the server. Note: This ReversalType is only valid for the Heartland Processor |
rtTimeout (4) | Time Out Reversal for credit card transactions. This reversal type is used to reverse a credit card transaction when the POS application times out waiting for a response from the server. Note: This ReversalType is only valid for the Heartland Processor |
rtCreditAuthorization (5) | Credit Authorization Reversal. Used to reverse an Online Purchase Return Authorization. |
Data Type
Integer
SettlementAmount Property (TSYSReversal Component)
The new Settlement Amount for this transaction.
Syntax
__property String SettlementAmount = { read=FSettlementAmount, write=FSetSettlementAmount };
Default Value
""
Remarks
When performing an Authorization Reversal transaction, this field must contain a one to 12-character numeric transaction amount to be settled. The host subtracts this amount from the TotalAuthorizedAmount to derive the actual authorization amount to be reversed.
This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.
Data Type
String
SharingGroup Property (TSYSReversal Component)
List of Debit and EBT networks that the merchant supports.
Syntax
__property String SharingGroup = { read=FSharingGroup, write=FSetSharingGroup };
Default Value
""
Remarks
This one to 30-character property contains a listing of direct debit and EBT networks that a Point of Sale (POS) device can access. This property is provided by the signing member or processor, and the values must correspond to one of the Visa assigned direct debit network types. This value should be set to the value of the SharingGroup of the original TSYSDebit or TSYSBenefit authorization.
This field is only used for Debit reversals and Benefit/EBT reversals.
Data Type
String
SSLAcceptServerCertEncoded Property (TSYSReversal Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded }; __property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };
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
Byte Array
SSLCertEncoded Property (TSYSReversal Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded }; __property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };
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
Byte Array
SSLCertStore Property (TSYSReversal Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore }; __property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };
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
Byte Array
SSLCertStorePassword Property (TSYSReversal Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };
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 (TSYSReversal Component)
This is the type of certificate store for this certificate.
Syntax
__property TibcTSYSReversalSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TibcTSYSReversalSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component 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 component. 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 (TSYSReversal Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };
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 (TSYSReversal Component)
This specifies the SSL/TLS implementation to use.
Syntax
__property TibcTSYSReversalSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };
enum TibcTSYSReversalSSLProviders { sslpAutomatic=0, sslpPlatform=1, sslpInternal=2 };
Default Value
sslpAutomatic
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 component 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 component will select a provider depending on the current platform.
When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.
Data Type
Integer
SSLServerCertEncoded Property (TSYSReversal Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded }; __property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };
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
Byte Array
Timeout Property (TSYSReversal Component)
A timeout for the component.
Syntax
__property int Timeout = { read=FTimeout, write=FSetTimeout };
Default Value
30
Remarks
If Timeout is set to a positive value, and an operation cannot be completed immediately, the component will retry the operation for a maximum of Timeout seconds.
The default value for Timeout is 30 (seconds).
Data Type
Integer
TotalAuthorizedAmount Property (TSYSReversal Component)
The amount originally authorized.
Syntax
__property String TotalAuthorizedAmount = { read=FTotalAuthorizedAmount, write=FSetTotalAuthorizedAmount };
Default Value
""
Remarks
When performing an Authorization Reversal transaction, this field is to contain the total sum of all amounts authorized for this transaction (including any and all incremental authorizations). The TotalAuthorizedAmount minus the SettlementAmount will be the total amount reversed.
This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.
Data Type
String
TraceAuditNumber Property (TSYSReversal Component)
System Trace Audit Number returned for Debit and EBT transactions.
Syntax
__property String TraceAuditNumber = { read=FTraceAuditNumber, write=FSetTraceAuditNumber };
Default Value
""
Remarks
This setting contains a unique host message identifier assigned by the authorizing system, and is returned in Debit, EBT, and Gift Card response messages. This value should be set to the Trace returned in the response of the original TSYSDebit or TSYSBenefit authorization.
This field is only used for Debit and Benefit/EBT reversals.
Data Type
String
TransactionDate Property (TSYSReversal Component)
The Response TransactionDate of the transaction being reversed.
Syntax
__property String TransactionDate = { read=FTransactionDate, write=FSetTransactionDate };
Default Value
""
Remarks
The format for this property is MMDDYY.
Data Type
String
TransactionId Property (TSYSReversal Component)
The Response TransactionId of the transaction being reversed.
Syntax
__property String TransactionId = { read=FTransactionId, write=FSetTransactionId };
Default Value
""
Remarks
This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property, it should merely submit it in the reversal transaction.
Data Type
String
TransactionNumber Property (TSYSReversal Component)
Sequence number of this transaction.
Syntax
__property int TransactionNumber = { read=FTransactionNumber, write=FSetTransactionNumber };
Default Value
0
Remarks
This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.
Data Type
Integer
TransactionTime Property (TSYSReversal Component)
The Response TransactionTime of the transaction being reversed.
Syntax
__property String TransactionTime = { read=FTransactionTime, write=FSetTransactionTime };
Default Value
""
Remarks
The format for this property is HHMMSS.
Data Type
String
Config Method (TSYSReversal Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
Interrupt Method (TSYSReversal Component)
Interrupts the current action.
Syntax
void __fastcall Interrupt();
Remarks
This method interrupts any processing that the component is currently executing.
ParseAggregate Method (TSYSReversal Component)
Parses the aggregate returned from another component's GetDetailAggregate method.
Syntax
void __fastcall ParseAggregate(String Aggregate);
Remarks
This method takes the XML aggregate returned from the TSYSRetail or TSYSHealthCare component, parses it, and then fills all the properties of this component with the information contained in the XML. Then call Reverse to reverse the transaction. You may also set these properties manually.
Reset Method (TSYSReversal Component)
Clears all properties to their default values.
Syntax
void __fastcall Reset();
Remarks
This method clears all properties to their default values.
Reverse Method (TSYSReversal Component)
Reverses a previously authorized transaction.
Syntax
void __fastcall Reverse();
Remarks
To reverse a transaction, you need the following information from the original authorization:
- ApprovalCode
- CardholderId
- IndustryType
- RetrievalNumber
- ReturnedACI
- TotalAuthorizedAmount
- TransactionId
- TransactionDate
- TransactionTime
Instead of setting these properties by hand, it is preferred that you can ParseAggregate with the XML aggregate returned from the authorizing component's GetDetailRecord method.
Then simply set the ReversalType, ReversalCode, and the new SettlementAmount, and then call Reverse. If the reversal was successful the ResponseCode property will be "00". All of the other Response properties will be identical to the values submitted in the properties above.
NOTE: Reversal transactions are not to be entered into the batch settlement. If a transaction has been partially reversed, the original detail record must be updated with the new AuthorizedAmount and SettlementAmount. If the transaction has been completely reversed the original detail record MUST NOT be included in the batch settlement.
Connected Event (TSYSReversal Component)
Fired immediately after a connection completes (or fails).
Syntax
typedef struct { int StatusCode; String Description; } TibcTSYSReversalConnectedEventParams; typedef void __fastcall (__closure *TibcTSYSReversalConnectedEvent)(System::TObject* Sender, TibcTSYSReversalConnectedEventParams *e); __property TibcTSYSReversalConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };
Remarks
If the connection is made normally, StatusCode is 0, and Description is "OK".
If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
DataPacketIn Event (TSYSReversal Component)
Fired when receiving a data packet from the transaction server.
Syntax
typedef struct { String DataPacket; DynamicArray<Byte> DataPacketB; } TibcTSYSReversalDataPacketInEventParams; typedef void __fastcall (__closure *TibcTSYSReversalDataPacketInEvent)(System::TObject* Sender, TibcTSYSReversalDataPacketInEventParams *e); __property TibcTSYSReversalDataPacketInEvent OnDataPacketIn = { read=FOnDataPacketIn, write=FOnDataPacketIn };
Remarks
This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this component.
DataPacketOut Event (TSYSReversal Component)
Fired when sending a data packet to the transaction server.
Syntax
typedef struct { String DataPacket; DynamicArray<Byte> DataPacketB; } TibcTSYSReversalDataPacketOutEventParams; typedef void __fastcall (__closure *TibcTSYSReversalDataPacketOutEvent)(System::TObject* Sender, TibcTSYSReversalDataPacketOutEventParams *e); __property TibcTSYSReversalDataPacketOutEvent OnDataPacketOut = { read=FOnDataPacketOut, write=FOnDataPacketOut };
Remarks
This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this component.
Disconnected Event (TSYSReversal Component)
Fired when a connection is closed.
Syntax
typedef struct { int StatusCode; String Description; } TibcTSYSReversalDisconnectedEventParams; typedef void __fastcall (__closure *TibcTSYSReversalDisconnectedEvent)(System::TObject* Sender, TibcTSYSReversalDisconnectedEventParams *e); __property TibcTSYSReversalDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.
Please refer to the Error Codes section for more information.
Error Event (TSYSReversal Component)
Information about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TibcTSYSReversalErrorEventParams; typedef void __fastcall (__closure *TibcTSYSReversalErrorEvent)(System::TObject* Sender, TibcTSYSReversalErrorEventParams *e); __property TibcTSYSReversalErrorEvent OnError = { read=FOnError, write=FOnError };
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 (TSYSReversal Component)
Fired after the server presents its certificate to the client.
Syntax
typedef struct { String CertEncoded; DynamicArray<Byte> CertEncodedB; String CertSubject; String CertIssuer; String Status; bool Accept; } TibcTSYSReversalSSLServerAuthenticationEventParams; typedef void __fastcall (__closure *TibcTSYSReversalSSLServerAuthenticationEvent)(System::TObject* Sender, TibcTSYSReversalSSLServerAuthenticationEventParams *e); __property TibcTSYSReversalSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };
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 (TSYSReversal Component)
Fired when secure connection progress messages are available.
Syntax
typedef struct { String Message; } TibcTSYSReversalSSLStatusEventParams; typedef void __fastcall (__closure *TibcTSYSReversalSSLStatusEvent)(System::TObject* Sender, TibcTSYSReversalSSLStatusEventParams *e); __property TibcTSYSReversalSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (TSYSReversal Component)
The component 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 component, access to these internal properties is provided through the Config method.TSYSReversal Config Settings
Valid values are:
Code | Description |
A | Bar code/Payment code read |
D | Full magnetic stripe read and transmit, Track two |
G | Chip Card Read Data (CCPS) |
H | Full magnetic stripe read and transmit, Track one |
P | Manually keyed, Chip Card read capable terminal |
Q | Proximity payment device using track data rules (transmit only Track two to Sierra) |
R | Proximity payment device using EMV-Chip data rules |
S | Full magnetic stripe read (Track two only), Chip Card capable terminal |
T | Manually keyed, Track two capable |
X | Manually keyed, Track one capable |
@ | Manually keyed, terminal has no card reading capability |
W | Chip Card transaction processed as magnetic stripe due to the terminal application not having any EMV applications in common with the chip card. |
Z | Chip Card transaction processed as magnetic stripe from a chip capable terminal, due to card or terminal failure. |
If Canada Domestic Indicator was present in the original transaction it must be included in a reversal message.
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.
0 | No Encryption (default) |
1 | Merchant ID and Card Data (reserved for future use) |
2 | Merchant ID, Card Data, and Card Security Code (reserved for future use) |
3 | Card Data Only |
Note you will also need to set Processor to 1 (Heartland) and HeartlandKeyBlock if you wish to process Heartland E3 transactions.
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 |
Code Example:
TSYSRetail.Config("POSDataCode=CardholderAuthCap=1;CardInputMode=2;CardInputCap=2");
CardInputCap (Terminal card data input capability)
0 (default) | Unspecified, data not available |
1 | Manual; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader capability |
3 | Bar code/ Payment code |
4 | Optical character reader (OCR) capability, [MC, AX] |
5 | Integrated circuit card (ICC) capability and magnetic stripe reader |
6 | Key entry only capability; Mastercard recurring and installment transactions |
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 entry capability |
H | ICC Reader and Contactless Capability; Magnetic stripe & manual entry implied |
M | PAN auto-entry via contactless chip |
V | Other capability, [MC] |
X | Reserved for private use |
CardholderAuthCap (Terminal cardholder authentication capability)
0 | No electronic authentication capability |
1 | PIN entry capability |
2 | Electronic signature analysis capability |
3 | mPOS software-based PIN entry capability |
5 | Electronic authentication capability is inoperative |
6 | Other |
9 (default) | Unspecified, data not available |
CardCaptureCap (Terminal card-capture capability)
0 | No capture capability |
1 | Card capture capability |
9 (default) | Unspecified, data not available |
TerminalOpEnv (Terminal operating environment)
0 | No terminal used; Voice auth/ARU; Mastercard recurring/installment transactions |
1 | On card acceptor premises; attended terminal |
2 | On card acceptor premises; unattended terminal |
3 | Off card acceptor premises; attended |
4 | Off card acceptor premises; unattended |
5 | On cardholder premises; unattended |
6 | Off cardholder premises; unattended |
9 (default) | Unspecified, data not available |
M | Off card acceptor premises; merchant mobile POS environment, including mPOS |
P | On card acceptor premises; merchant mobile POS environment, including mPOS |
Q | Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
R | On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
S | Electronic delivery of product, [AX] |
T | Physical delivery of product, [AX] |
CardholderPresent (Cardholder present data)
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 |
5 | Cardholder not present; electronic commerce |
8 | Cardholder not present; recurrent billing such as a loan or installment payment |
R | Recurring purchase transaction (original transaction was token-based with valid cryptogram) |
T | PayButton (Discover only) |
CardPresent (Card present data)
0 | Card not present |
1 | Card present |
W | Transponder, [AX] |
X | Contactless Chip Transactions, including AMEX Expresspay |
Z | Digital Wallet [AX] |
CardInputMode (Card data input mode)
0 (default) | Unspecified, data not available |
1 | Manual input; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader input |
3 | Bar code/Payment code |
6 | Key entered input |
7 | Payment Credential stored on file. NOTE: This value is required for all Mastercard recurring transactions. |
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 Card (EMV Mode) |
N | Track data read and sent unaltered, chip capable terminal, chip data could not be read |
P | Empty candidate list fallback |
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, [AX, JCB Canada] |
W | Swiped transaction with keyed CID, [AX, JCB Canada] |
X | Reserved for private use |
Y | Reserved for private use |
Z | Contactless Interface Change Identifies when a Chip Card Transaction with a dualinterface card switches from a contactless to a contact chip card transaction [Discover] |
NOTE: AMEX defines ApplePay with value C - Online Chip
CardholderAuthMethod (Cardholder authentication method)
0 | Not authenticated |
1 | PIN |
2 | Electronic signature analysis |
5 | Manual signature verification |
6 | Other manual verification (such as a driver's license number) |
9 (default) | Unspecified, data not available |
S | Other systematic verification |
T | Electronic ticket environment, [AX] |
CardholderAuthEntity (Cardholder authentication entity)
0 | Not authenticated |
1 | ICC - Offline PIN |
2 | Card acceptance device (CAD) |
3 | Authorizing agent - Online PIN |
4 | Merchant/card acceptor - signature |
5 | Other |
9 (default) | Unspecified, data not available |
CardOutputCap (Card data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Magnetic stripe write |
3 | ICC |
S | Other |
TerminalOutputCap (Terminal data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Printing capability only |
3 | Display capability only |
4 | Printing and display capability |
PINCaptureCap (PIN capture capability)
0 | No PIN capture capability |
1 (default) | Unspecified, 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 six 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 10 characters maximum |
B | PIN capture capability 11 characters maximum |
C | PIN capture capability 12 characters maximum |
Note: Setting this configuration setting in TSYSDetailRecord component will not update the POSDataCode tag in the detail aggregate of the original transaction.
0 | TSYS (default) |
1 | Heartland |
Note that when set, this property will set the Server and Port to the default values for the specified processor. Additionally, this config must be set prior to setting Card to ensure the card data is formatted correctly.
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.
If Card Brand Token Requestor ID was present in the original transaction it must be included in a reversal message.
Note: The component will also send this value as part of DetailExtension Config of TSYSDetailRecord component (Group ODG41 - tag "TRI").
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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components 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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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 component 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 component initiate connections (or accept in the case of server components) only through that interface.
If the component 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 component 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 component is the same.
-----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 set to 0 (default) the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
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 component 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 component 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 component 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 component 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 component 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 component 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 component raises an exception.
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 component 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 component 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 components: 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 component to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (TSYSReversal Component)
TSYSReversal 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 component may also return one of the following error codes, which are inherited from other components.
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 component 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). |