TSYSHealthCare Module

Properties Methods Events Config Settings Errors

The TSYSHEALTHCARE module is designed to be a simple interface for those wishing to add Healthcare Auto- Substantiation (IIAS) support without redesigning their entire payment system. This module is used to authorize FSA cards in a Retail environment, where the customer is purchasing products or services in person. Both full and partial authorizations are supported.

Syntax

DPaymentsSDK.Tsyshealthcare

Remarks

This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSHealthCare class has the ability to authorize transactions for the Retail, Direct Marketing (including E-Commerce), and Grocery Store IndustryTypes. However, at this time TSYS is only allowing IIAS Auto-Substantiation transactions in the Retail environment.

The TSYSHealthCare class makes authorizing IIAS transactions very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are very similar to that of the TSYSRetail class. The basic steps are outlined below:

First, set the merchant properties with setup information acquired from your member bank or processor. For instance:

class.Merchant.BankId = "999995"; //(BIN number) class.Merchant.CategoryCode = "5999"; class.Merchant.Name = "test merchant"; class.Merchant.Number = "123456789012"; class.Merchant.City = "Beverly Hills"; class.Merchant.State = "CA"; class.Merchant.StoreNumber = "5999"; class.Merchant.TerminalNumber = "1515"; class.Merchant.Zip = "90210"; class.IndustryType = itRetail;

Now, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing track1, and for these cards you may use track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with track1 data.

class.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?"; class.Card.EntryDataSource = edsTrack1;

Next set the TransactionAmount, TotalMedicalAmount, and optionally any additional healthcare-related amounts. Up to three additional amounts may be included, but their sums cannot exceed the TotalMedicalAmount. The available amounts include: ClinicAmount, DentalAmount, PrescriptionAmount, and VisionAmount.

class.TransactionAmount = "10000"; // $100.00 class.TotalMedicalAmount = "10000"; // this cannot exceed the TransactionAmount class.PrescriptionAmount = "5000"; // $50.00

There are several additional properties in the TSYSHealthCare class that are specific to healthcare transactions. The PartialAuthorization property indicates whether you allow partial authorizations. If TotalMedicalAmount is less than the TransactionAmount, the transaction will likely be declined as FSA cards are to be used solely for medical expenses. Likewise, if the FSA card does not have enough of a balance to cover the total amount, the card may be declined. However, if you set PartialAuthorization to True the host may authorize the transaction for a lesser amount. In this case the ResponseCode will be "10" instead of "00", and the ResponseAuthorizedAmount will contain the amount that was actually authorized (this amount may or may not be equal to the TotalMedicalAmount). Note: if the cardholder does not have additional funds to cover the remainder of the TransactionAmount and wishes to cancel the transaction, you must use the TSYSReversal class to reverse the authorization and instantly release funds back to the cardholder.

The Visa Merchant Verification Value, or VisaMVV is needed for Visa transactions in order to qualify for the best interchange rate.

Finally, the Substantiated property is a MasterCard-specific property that indicates if the transaction has been substantiated in real-time. Meaning, it tells the host whether the merchant verified the purchased items against an Inventory Information Approval System (IIAS).

After all of these properties are set, simply call the Authorize method to authorize the transaction. When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved, and the ResponseAVSResult indicates whether the customer's billing address on file with his credit card company matches the information presented in the CustomerAddress and CustomerZip properties. The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the TSYSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.


Card	Contains the customer's credit card information.
CardPresent	Indicates whether the current transaction is a card present transaction.
ClinicAmount	Total amount of Clinic or Other qualified medical items for Healthcare auto-substantiation.
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
DentalAmount	Total amount of Dental items for Healthcare auto-substantiation.
IndustryType	Code which indicates the industry the merchant is engaged in.
Merchant	Contains the merchant's setup information.
PartialAuthorization	Indicates whether partial authorizations are to be supported for Health Care Auto-Substantiation transactions.
PrescriptionAmount	Total amount of Prescription/Rx items for Healthcare auto-substantiation.
Response	Contains the response to an authorization request.
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).
Substantiated	Identifies if the merchant verified the purchased items against an Inventory Information Approval System (IIAS).
Timeout	A timeout for the module.
TotalMedicalAmount	Sum total of all medical item amounts.
TransactionAmount	Purchase amount to be authorized.
TransactionNumber	Sequence number of this transaction.
VisaMVV	The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program.
VisionAmount	Total amount of Vision or Optical items for Healthcare auto-substantiation.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.


Authorize	Authorizes a healthcare transaction with IIAS data.
Config	Sets or retrieves a configuration setting.
EligibilityInquiry	Healthcare Eligibility Inquiry (Visa and MasterCard Only).
GetDetailAggregate	Returns an aggregate containing details of this transaction, which is then used for settlement.
Interrupt	Interrupts the current action.
Reset	Clears all properties to their default values.

Event List

The following is the full list of the events fired by the module 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 module with short descriptions. Click on the links for further details.


AuthorizationIndicator	The type of authorization request.
CanadaDomesticIndicator	Canada Domestic Indicator.
CITMITIndicator	CIT/MIT Indicator.
CumulativeAmount	Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only).
ECI	Electronic Commerce Indicator.
GatewayID	A unique value to identify a Gateway or Aggregator.
GenKey	A randomly generated string of alphanumeric characters identifying the terminal.
HealthCareMemberData	Healthcare Member Data (Mastercard and Discover only).
IncrementalApprovalCode	Transaction Approval Code associated with authorization to increment.
IncrementalRetrievalNumber	Transaction Retrieval Number associated with authorization to increment.
IncrementalTransDate	Transaction Date associated with authorization to increment.
IncrementalTransId	Transaction Id associated with authorization to increment.
IncrementalTransTime	Transaction Time associated with authorization to increment.
IsMerchantInitiatedTransaction	Set this to process a Merchant Initiated transaction.
IsPurchaseReturnAuthorization	Set this to process a Purchase Return Authorization transaction.
MastercardWalletId	Mastercard Wallet Identifier used to identify the Wallet Provider.
MessageReasonCode	Code used to identify MIT or Deferred Authorizations for Visa.
MITTransactionId	Transaction Id associated with the original authorization of a Merchant Initiated Transaction.
MPGID	Merchant Payment Gateway ID.
Port	The port to which transactions are posted.
POSDataCode	Specifies the condition of the POS device used at the time of the transaction.
POSEnvironmentIndicator	Provides additional information about the transaction for Visa.
ResponseTransactionIntegrityClass	A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class.
Server	The server to which transactions are posted.
TLID	Transaction Link Identifier.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the module 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 module 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.

Card Property (TSYSHealthCare Module)

Contains the customer's credit card information.

public var card: CCCard {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=cardType,setter=setCardType:) int cardType;

- (int)cardType;
- (void)setCardType :(int)newCardType;

@property (nonatomic,readwrite,assign,getter=cardCVVData,setter=setCardCVVData:) NSString* cardCVVData;

- (NSString*)cardCVVData;
- (void)setCardCVVData :(NSString*)newCardCVVData;

@property (nonatomic,readwrite,assign,getter=cardCVVPresence,setter=setCardCVVPresence:) int cardCVVPresence;

- (int)cardCVVPresence;
- (void)setCardCVVPresence :(int)newCardCVVPresence;

@property (nonatomic,readwrite,assign,getter=cardEntryDataSource,setter=setCardEntryDataSource:) int cardEntryDataSource;

- (int)cardEntryDataSource;
- (void)setCardEntryDataSource :(int)newCardEntryDataSource;

@property (nonatomic,readwrite,assign,getter=cardExpMonth,setter=setCardExpMonth:) int cardExpMonth;

- (int)cardExpMonth;
- (void)setCardExpMonth :(int)newCardExpMonth;

@property (nonatomic,readwrite,assign,getter=cardExpYear,setter=setCardExpYear:) int cardExpYear;

- (int)cardExpYear;
- (void)setCardExpYear :(int)newCardExpYear;

@property (nonatomic,readwrite,assign,getter=cardIsEncrypted,setter=setCardIsEncrypted:) BOOL cardIsEncrypted;

- (BOOL)cardIsEncrypted;
- (void)setCardIsEncrypted :(BOOL)newCardIsEncrypted;

@property (nonatomic,readwrite,assign,getter=cardMagneticStripe,setter=setCardMagneticStripe:) NSString* cardMagneticStripe;

- (NSString*)cardMagneticStripe;
- (void)setCardMagneticStripe :(NSString*)newCardMagneticStripe;

@property (nonatomic,readwrite,assign,getter=cardNumber,setter=setCardNumber:) NSString* cardNumber;

- (NSString*)cardNumber;
- (void)setCardNumber :(NSString*)newCardNumber;

Default Value

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a for swiped cards, or a , , and for manually entered cards. ( indicates which set of properties will be used). See the CCCard type for more information.

CardPresent Property (TSYSHealthCare Module)

Indicates whether the current transaction is a card present transaction.

Syntax

Swift
Objective-C

public var cardPresent: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=cardPresent,setter=setCardPresent:) BOOL cardPresent;

- (BOOL)cardPresent;
- (void)setCardPresent :(BOOL)newCardPresent;

Default Value

True

Remarks

By default, this class handles only retail card-present transactions. However, there are times at which a retail merchant may need to make a card-not-present transaction. For instance, hotel reservations, pre-orders, and the like. By setting this property to False a merchant may submit a card-not-present transaction. However, merchants that deal primarily in card-not-present transactions (either over the Internet or over the telephone) should use the TSYSECommerce class instead.

ClinicAmount Property (TSYSHealthCare Module)

Total amount of Clinic or Other qualified medical items for Healthcare auto-substantiation.

Syntax

Swift
Objective-C

public var clinicAmount: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=clinicAmount,setter=setClinicAmount:) NSString* clinicAmount;

- (NSString*)clinicAmount;
- (void)setClinicAmount :(NSString*)newClinicAmount;

Default Value

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

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.

CustomerAddress Property (TSYSHealthCare Module)

The customer's billing address.

Syntax

Swift
Objective-C

public var customerAddress: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=customerAddress,setter=setCustomerAddress:) NSString* customerAddress;

- (NSString*)customerAddress;
- (void)setCustomerAddress :(NSString*)newCustomerAddress;

Default Value

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

This property is an alphanumeric field. Due to concerns with International addresses and changing specifications, the component does not do any processing on the address. The address will be included in the authorization request exactly as you set it.

Per TSYS specs, the following rules apply:

In the address, numbers are not spelled out. "First Street" becomes "1ST Street," "Second" becomes "2ND," and so on.
There must be a (space) between two consecutive data elements that are only numeric.

In order to maximize the address information included in the request, it is suggested that you strip out the spaces (when possible) and punctuations before setting the property.

Note the following examples:

"1234 56th Street" is equivalent to: "1234 56Street"
"1234 56th Street" is NOT equivalent to: "123456Street" //do not strip all spaces between two numbers
"1391 ELM STREET" is equivalent to: "1391ELMSTREET"
"P.O. BOX 24356" is equivalent to: "POBOX24356"

The length of this property is 19 characters, and any string longer than this . If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

CustomerZip Property (TSYSHealthCare Module)

Customer's zip code (or postal code if outside of the USA).

Syntax

Swift
Objective-C

public var customerZip: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=customerZip,setter=setCustomerZip:) NSString* customerZip;

- (NSString*)customerZip;
- (void)setCustomerZip :(NSString*)newCustomerZip;

Default Value

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

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

DentalAmount Property (TSYSHealthCare Module)

Total amount of Dental items for Healthcare auto-substantiation.

Syntax

Swift
Objective-C

public var dentalAmount: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=dentalAmount,setter=setDentalAmount:) NSString* dentalAmount;

- (NSString*)dentalAmount;
- (void)setDentalAmount :(NSString*)newDentalAmount;

Default Value

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

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.

IndustryType Property (TSYSHealthCare Module)

Code which indicates the industry the merchant is engaged in.

Syntax

Swift
Objective-C

public var industryType: TsyshealthcareIndustryTypes {
  get {...}
  set {...}
}

public enum TsyshealthcareIndustryTypes: Int32 {
  case sitUnknown = 0
  case sitRetail = 1
  case sitRestaurant = 2
  case sitGroceryStore = 3
  case sitDirectMarketing = 4
  case sitHotel = 5
  case sitAutoRental = 6
  case sitPassengerTransport = 7
}


@property (nonatomic,readwrite,assign,getter=industryType,setter=setIndustryType:) int industryType;

- (int)industryType;
- (void)setIndustryType :(int)newIndustryType;

Default Value

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.


sitUnknown (0)	Unknown or unsure.
sitRetail (1)	Retail store.
sitRestaurant (2)	Food / Restaurant.
sitGroceryStore (3)	Grocery store or supermarket.
sitDirectMarketing (4)	eCommerce or Direct Marketing
sitHotel (5)	Hotel / Lodging
sitAutoRental (6)	Auto Rental
sitPassengerTransport (7)	Passenger Transport

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

Merchant Property (TSYSHealthCare Module)

Contains the merchant's setup information.

Syntax

Swift
Objective-C

public var merchant: TSYSMerchant {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=merchantBankId,setter=setMerchantBankId:) NSString* merchantBankId;

- (NSString*)merchantBankId;
- (void)setMerchantBankId :(NSString*)newMerchantBankId;

@property (nonatomic,readwrite,assign,getter=merchantCategoryCode,setter=setMerchantCategoryCode:) NSString* merchantCategoryCode;

- (NSString*)merchantCategoryCode;
- (void)setMerchantCategoryCode :(NSString*)newMerchantCategoryCode;

@property (nonatomic,readwrite,assign,getter=merchantCity,setter=setMerchantCity:) NSString* merchantCity;

- (NSString*)merchantCity;
- (void)setMerchantCity :(NSString*)newMerchantCity;

@property (nonatomic,readwrite,assign,getter=merchantCountryCode,setter=setMerchantCountryCode:) NSString* merchantCountryCode;

- (NSString*)merchantCountryCode;
- (void)setMerchantCountryCode :(NSString*)newMerchantCountryCode;

@property (nonatomic,readwrite,assign,getter=merchantCurrencyCode,setter=setMerchantCurrencyCode:) NSString* merchantCurrencyCode;

- (NSString*)merchantCurrencyCode;
- (void)setMerchantCurrencyCode :(NSString*)newMerchantCurrencyCode;

@property (nonatomic,readwrite,assign,getter=merchantLanguage,setter=setMerchantLanguage:) NSString* merchantLanguage;

- (NSString*)merchantLanguage;
- (void)setMerchantLanguage :(NSString*)newMerchantLanguage;

@property (nonatomic,readwrite,assign,getter=merchantName,setter=setMerchantName:) NSString* merchantName;

- (NSString*)merchantName;
- (void)setMerchantName :(NSString*)newMerchantName;

@property (nonatomic,readwrite,assign,getter=merchantNumber,setter=setMerchantNumber:) NSString* merchantNumber;

- (NSString*)merchantNumber;
- (void)setMerchantNumber :(NSString*)newMerchantNumber;

@property (nonatomic,readwrite,assign,getter=merchantPhone,setter=setMerchantPhone:) NSString* merchantPhone;

- (NSString*)merchantPhone;
- (void)setMerchantPhone :(NSString*)newMerchantPhone;

@property (nonatomic,readwrite,assign,getter=merchantServicePhone,setter=setMerchantServicePhone:) NSString* merchantServicePhone;

- (NSString*)merchantServicePhone;
- (void)setMerchantServicePhone :(NSString*)newMerchantServicePhone;

@property (nonatomic,readwrite,assign,getter=merchantState,setter=setMerchantState:) NSString* merchantState;

- (NSString*)merchantState;
- (void)setMerchantState :(NSString*)newMerchantState;

@property (nonatomic,readwrite,assign,getter=merchantStoreNumber,setter=setMerchantStoreNumber:) NSString* merchantStoreNumber;

- (NSString*)merchantStoreNumber;
- (void)setMerchantStoreNumber :(NSString*)newMerchantStoreNumber;

@property (nonatomic,readwrite,assign,getter=merchantStreetAddress,setter=setMerchantStreetAddress:) NSString* merchantStreetAddress;

- (NSString*)merchantStreetAddress;
- (void)setMerchantStreetAddress :(NSString*)newMerchantStreetAddress;

@property (nonatomic,readwrite,assign,getter=merchantTerminalNumber,setter=setMerchantTerminalNumber:) NSString* merchantTerminalNumber;

- (NSString*)merchantTerminalNumber;
- (void)setMerchantTerminalNumber :(NSString*)newMerchantTerminalNumber;

@property (nonatomic,readwrite,assign,getter=merchantTimeZone,setter=setMerchantTimeZone:) NSString* merchantTimeZone;

- (NSString*)merchantTimeZone;
- (void)setMerchantTimeZone :(NSString*)newMerchantTimeZone;

@property (nonatomic,readwrite,assign,getter=merchantZip,setter=setMerchantZip:) NSString* merchantZip;

- (NSString*)merchantZip;
- (void)setMerchantZip :(NSString*)newMerchantZip;

Default Value

Remarks

This property must be set to an instance of the TSYSMerchant type, which will contain information to identify the merchant to the TSYS processing server. Please see the TSYSMerchant type for a list of available properties.

PartialAuthorization Property (TSYSHealthCare Module)

Indicates whether partial authorizations are to be supported for Health Care Auto-Substantiation transactions.

Syntax

Swift
Objective-C

public var partialAuthorization: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=partialAuthorization,setter=setPartialAuthorization:) BOOL partialAuthorization;

- (BOOL)partialAuthorization;
- (void)setPartialAuthorization :(BOOL)newPartialAuthorization;

Default Value

False

Remarks

If the TotalMedicalAmount is not the same as the TransactionAmount the FSA card may be declined, as FSA cards may only be used for healthcare-related purchases. However, if you set PartialAuthorization to true, the transaction may be authorized for the TotalMedicalAmount. The customer must then make up the difference between the TransactionAmount and TotalMedicalAmount via some other form of payment (cash, credit, check, etc).

The total amount authorized by TSYS will be returned in the ResponseAuthorizedAmount. For instance, if the TransactionAmount is $50, but the TotalMedicalAmount is $42, the card is charged for $42.00 and the ResponseAuthorizedAmount will be "42.00". The merchant may then collect the remaining $8 in cash, check, credit card, or any other acceptable form of payment.

PrescriptionAmount Property (TSYSHealthCare Module)

Total amount of Prescription/Rx items for Healthcare auto-substantiation.

Syntax

Swift
Objective-C

public var prescriptionAmount: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=prescriptionAmount,setter=setPrescriptionAmount:) NSString* prescriptionAmount;

- (NSString*)prescriptionAmount;
- (void)setPrescriptionAmount :(NSString*)newPrescriptionAmount;

Default Value

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

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.

Response Property (TSYSHealthCare Module)

Contains the response to an authorization request.

Syntax

Swift
Objective-C

public var response: TSYSHealthCareResponse {
  get {...}
}


@property (nonatomic,readonly,assign,getter=responseApprovalCode) NSString* responseApprovalCode;

- (NSString*)responseApprovalCode;

@property (nonatomic,readonly,assign,getter=responseAuthorizedAmount) NSString* responseAuthorizedAmount;

- (NSString*)responseAuthorizedAmount;

@property (nonatomic,readonly,assign,getter=responseAuthSource) NSString* responseAuthSource;

- (NSString*)responseAuthSource;

@property (nonatomic,readonly,assign,getter=responseAVSResult) NSString* responseAVSResult;

- (NSString*)responseAVSResult;

@property (nonatomic,readonly,assign,getter=responseBalance) NSString* responseBalance;

- (NSString*)responseBalance;

@property (nonatomic,readonly,assign,getter=responseCode) NSString* responseCode;

- (NSString*)responseCode;

@property (nonatomic,readonly,assign,getter=responseCVVResult) NSString* responseCVVResult;

- (NSString*)responseCVVResult;

@property (nonatomic,readonly,assign,getter=responseRetrievalNumber) NSString* responseRetrievalNumber;

- (NSString*)responseRetrievalNumber;

@property (nonatomic,readonly,assign,getter=responseReturnedACI) NSString* responseReturnedACI;

- (NSString*)responseReturnedACI;

@property (nonatomic,readonly,assign,getter=responseText) NSString* responseText;

- (NSString*)responseText;

@property (nonatomic,readonly,assign,getter=responseTransactionDate) NSString* responseTransactionDate;

- (NSString*)responseTransactionDate;

@property (nonatomic,readonly,assign,getter=responseTransactionId) NSString* responseTransactionId;

- (NSString*)responseTransactionId;

@property (nonatomic,readonly,assign,getter=responseTransactionNumber) NSString* responseTransactionNumber;

- (NSString*)responseTransactionNumber;

@property (nonatomic,readonly,assign,getter=responseTransactionTime) NSString* responseTransactionTime;

- (NSString*)responseTransactionTime;

@property (nonatomic,readonly,assign,getter=responseValidationCode) NSString* responseValidationCode;

- (NSString*)responseValidationCode;

Default Value

Remarks

This property will contain the response returned from the TSYS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The TSYSResponse type contains the following fields:


	Contains an authorization code for approved transactions, or a description of the error for declines.
	Amount actually used from the card (used when supporting partial redemptions).
	Indicates the source of the authorization code stored in .
	Contains the Address Verification System result code.
	This field contains a two-character code created by Visa during the authorization process.
	Indicates the status of the authorization request.
	Indicates whether the credit card charged is a corporate commercial card (and if so the type of commercial card).
	Contains the returned CVV result code (if CVV data was sent in the request).
	This number is to be submitted for reversals or at settlement.
	Returned Authorization Characteristics Indicator contains CPS qualification status.
	Text information that describes each response code.
	Local transaction date returned from the server in MMDDYY format.
	Contains the Transaction Identifier or MasterCard Reference Number.
	Check this property against the TransactionNumber sent in the authorization.
	Local transaction time returned from the server in HHMMSS format.
	Additional information generated by the card issuer.

SSLAcceptServerCertEncoded Property (TSYSHealthCare Module)

This is the certificate (PEM/Base64 encoded).

Syntax

Swift
Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (TSYSHealthCare Module)

This is the certificate (PEM/Base64 encoded).

Syntax

Swift
Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (TSYSHealthCare Module)

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

Syntax

Swift
Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

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

SSLCertStorePassword Property (TSYSHealthCare Module)

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

Syntax

Swift
Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (TSYSHealthCare Module)

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

public var sslCertStoreType: TsyshealthcareSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum TsyshealthcareSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}


@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

Remarks

This is the type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SSLCertSubject Property (TSYSHealthCare Module)

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

Syntax

Swift
Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (TSYSHealthCare Module)

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

public var sslProvider: TsyshealthcareSSLProviders {
  get {...}
  set {...}
}

public enum TsyshealthcareSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}


@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:


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

Additional Notes

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

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (TSYSHealthCare Module)

This is the certificate (PEM/Base64 encoded).

Syntax

Swift
Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}


@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Substantiated Property (TSYSHealthCare Module)

Identifies if the merchant verified the purchased items against an Inventory Information Approval System (IIAS).

Syntax

Swift
Objective-C

public var substantiated: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=substantiated,setter=setSubstantiated:) int substantiated;

- (int)substantiated;
- (void)setSubstantiated :(int)newSubstantiated;

Default Value

Remarks

This Real-Time Substantiation field is only sent for MasterCard transactions.


Value	Description
0	Merchant terminal did not verify the purchased items against an IIAS
1	Merchant terminal verified the purchased items against an IIAS
2	Merchant claims exemption from IIAS based on the 90 percent rule

Timeout Property (TSYSHealthCare Module)

A timeout for the module.

Syntax

Swift
Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

TotalMedicalAmount Property (TSYSHealthCare Module)

Sum total of all medical item amounts.

Syntax

Swift
Objective-C

public var totalMedicalAmount: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=totalMedicalAmount,setter=setTotalMedicalAmount:) NSString* totalMedicalAmount;

- (NSString*)totalMedicalAmount;
- (void)setTotalMedicalAmount :(NSString*)newTotalMedicalAmount;

Default Value

Remarks

This property is required when submitting a Healthcare Auto-substantiation transaction, and should indicate the sum total of all VisionAmounts, PrescriptionAmounts, ClinicAmounts, and DentalAmounts, plus any additional healthcare-related charges that do not fall under those categories. The category-specific amounts are optional, but at the minimum the TotalMedicalAmount must be present for Healthcare auto-substantiation.

If other amounts are present, the TotalMedicalAmount must be greater than or equal to the total of all other amounts. If the TotalMedicalAmount is left blank, the transaction will be sent as a regular Retail transaction, without the healthcare indicator. If you wish to send a transaction with the healthcare indicator, but no TotalMedicalAmount, set TotalMedicalAmount to "0".

If the transaction is only for healthcare related costs, the TotalMedicalAmount should be equal to the TransactionAmount. However, it is possible to authorize a transaction that includes non-healthcare items, where the TransactionAmount is higher than the TotalMedicalAmount. It may be required that you set PartialAuthorization to True in order to support this functionality.

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.

TransactionAmount Property (TSYSHealthCare Module)

Purchase amount to be authorized.

Syntax

Swift
Objective-C

public var transactionAmount: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=transactionAmount,setter=setTransactionAmount:) NSString* transactionAmount;

- (NSString*)transactionAmount;
- (void)setTransactionAmount :(NSString*)newTransactionAmount;

Default Value

Remarks

This field contains the transaction amount to be authorized. The transaction amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated MerchantCurrencyCode. In the United States, the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

TransactionNumber Property (TSYSHealthCare Module)

Sequence number of this transaction.

Syntax

Swift
Objective-C

public var transactionNumber: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=transactionNumber,setter=setTransactionNumber:) int transactionNumber;

- (int)transactionNumber;
- (void)setTransactionNumber :(int)newTransactionNumber;

Default Value

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.

VisaMVV Property (TSYSHealthCare Module)

The Merchant Verification Value (MVV) is used by Visa to determine a merchant's eligibility to participate in a Select Merchant Fee (SMF) program.

Syntax

Swift
Objective-C

public var visaMVV: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=visaMVV,setter=setVisaMVV:) NSString* visaMVV;

- (NSString*)visaMVV;
- (void)setVisaMVV :(NSString*)newVisaMVV;

Default Value

Remarks

The maximum length of this property is 10 characters, and it may only contain 0-9 and A-F.

VisionAmount Property (TSYSHealthCare Module)

Total amount of Vision or Optical items for Healthcare auto-substantiation.

Syntax

Swift
Objective-C

public var visionAmount: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=visionAmount,setter=setVisionAmount:) NSString* visionAmount;

- (NSString*)visionAmount;
- (void)setVisionAmount :(NSString*)newVisionAmount;

Default Value

Remarks

The sum of all auto-substantiation items cannot be more than the TotalMedicalAmount, which must be equal to or less than the TransactionAmount.

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.

Authorize Method (TSYSHealthCare Module)

Authorizes a healthcare transaction with IIAS data.

Syntax

Swift
Objective-C

public func authorize() throws -> Void

- (void)authorize;

Remarks

This method sends an authorization request to the Vital/TSYS transaction server. If the authorization request was successful, the ResponseCode property will contain "00". If it's a partial authorization the ResponseCode will contain "10".

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the Settlement class. For example:

TSYSHealthCare.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailRecordAggregate(0) = TSYSHealthCare.GetDetailAggregate()

Config Method (TSYSHealthCare Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

EligibilityInquiry Method (TSYSHealthCare Module)

Healthcare Eligibility Inquiry (Visa and MasterCard Only).

Syntax

Swift
Objective-C

public func eligibilityInquiry() throws -> Void

- (void)eligibilityInquiry;

Remarks

This method does not send an authorization, but instead it sends an authentication request.

Note: When calling this method CardPresent must be set to 'True'

GetDetailAggregate Method (TSYSHealthCare Module)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

Swift
Objective-C

public func getDetailAggregate() throws -> String

- (NSString*)getDetailAggregate;

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method .

An example of how this method is used is shown below:

TSYSRetail.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()

Interrupt Method (TSYSHealthCare Module)

Interrupts the current action.

Syntax

Swift
Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

This method interrupts any processing that the class is currently executing.

Reset Method (TSYSHealthCare Module)

Clears all properties to their default values.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties to their default values.

Connected Event (TSYSHealthCare Module)

Fired immediately after a connection completes (or fails).

Syntax

Swift
Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

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 (TSYSHealthCare Module)

Fired when receiving a data packet from the transaction server.

Syntax

Swift
Objective-C

func onDataPacketIn(dataPacket: Data)

- (void)onDataPacketIn:(NSData*)dataPacket;

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (TSYSHealthCare Module)

Fired when sending a data packet to the transaction server.

Syntax

Swift
Objective-C

func onDataPacketOut(dataPacket: Data)

- (void)onDataPacketOut:(NSData*)dataPacket;

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (TSYSHealthCare Module)

Fired when a connection is closed.

Syntax

Swift
Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

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 (TSYSHealthCare Module)

Information about errors during data delivery.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

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 (TSYSHealthCare Module)

Fired after the server presents its certificate to the client.

Syntax

Swift
Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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 (TSYSHealthCare Module)

Fired when secure connection progress messages are available.

Syntax

Swift
Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the to indicate which track is stored in the field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the , , and fields, and must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the to edsManualEntryNoCardReader. If you wish to set any other value for the , you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of . If you set the , , and fields, but is set to edsTrack2, the class will look for data when authorizing the transaction, and will because none is present.

Fields

cardType
TCardTypes
Default Value: 0

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the 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)

cvvData
String
Default Value: ""

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 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, will be automatically set to cvpProvided. If set to empty string (""), will be automatically set to cvpNotProvided.

cvvPresence
CCCVVPresences
Default Value: 0

Indicates the presence of the card verification value.

This property is used to indicate the presence of .

The class will automatically set this value to cvpProvided when a value is specified. You can explicitly specify the indicator by setting this property.

Available values are:

cvpNotProvided (0)
cvpProvided (1)
cvpIllegible (2)
cvpNotOnCard (3)

entryDataSource
EntryDataSources
Default Value: 0

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. (, , and are sent).
edsKiosk (9)	Automated kiosk transaction. Track1 or Track2 data must be sent in , 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

expMonth
Int32
Default Value: 1

Expiration month of the credit card specified in .

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

expYear
Int32
Default Value: 2000

Expiration year of the credit card specified in .

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.

isEncrypted
Bool
Default Value: False

Determines whether data set to the or fields is validated.

By default, when the or fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and data will be parsed for the track specified by . 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 or fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the may be affected, and the card number will not be verified.

magneticStripe
String
Default Value: ""

Track data read off of the card's magnetic stripe.

If 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 property to indicate which track you are sending.

The following example shows how to set the and properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.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.

number
String
Default Value: ""

Customer's credit card number for the transaction.

If you're sending the transaction with data, this property should be left empty.

Constructors

public init()

public init(number: , expMonth: , expYear: )

public init(magneticStripe: , entryDataSource: )

TSYSHealthCareResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the TSYSHealthCare class. The properties contained by this type are listed below.

Fields

approvalCode
String (read-only)
Default Value: ""

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 returned indicates that the transaction has not been approved, then the contents of the property should be ignored. The must be stored and submitted in the settlement data capture record.

authorizedAmount
String (read-only)
Default Value: ""

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.

authSource
String (read-only)
Default Value: ""

Indicates the source of the authorization code stored in .

This property contains a one character code indicating the source of the . 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)

* Currently in use by Japan Acquirer Services (JAS).

avsResult
String (read-only)
Default Value: ""

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

balance
String (read-only)
Default Value: ""

Available balance remaining on card.

This property contains the Available Balance remaining on the card following the transaction that was just authorized. It represents the balance on the card prior to the transaction, minus the TransactionAmount from this transaction. For example, if an FSA card has a $20.00 balance prior to a $15.00 authorization, then the ResponseBalance will reflect an available balance of "500" ($20.00 - $15.00 = $5.00).

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

code
String (read-only)
Default Value: ""

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 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 s are listed in the table of contents.

cvvResult
String (read-only)
Default Value: ""

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

retrievalNumber
String (read-only)
Default Value: ""

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.

returnedACI
String (read-only)
Default Value: ""

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 or properties.

text
String (read-only)
Default Value: ""

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.

transactionDate
String (read-only)
Default Value: ""

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.

transactionId
String (read-only)
Default Value: ""

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.

transactionNumber
String (read-only)
Default Value: ""

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.

transactionTime
String (read-only)
Default Value: ""

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.

validationCode
String (read-only)
Default Value: ""

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.

Constructors

public init()

TSYSMerchant Type

Contains the merchant's setup information.

Remarks

This type contains the merchant's setup information. This includes the merchant identification, bank routing information, language, location, and other properties that identify the merchant to the TSYS server. Some of the information in these properties will be included on the customer's credit card statement, such as the merchant's , , , etc.

Fields

bankId
String
Default Value: ""

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 and to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

categoryCode
String
Default Value: ""

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

city
String
Default Value: ""

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 and must also be specified.

Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this property is ignored. is used for those industries instead of (this does not apply to MasterCard).

Note: This property must contain the same data used in the batch settlement. The first character of this property may not be a space. This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.

countryCode
String
Default Value: "840"

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

currencyCode
String
Default Value: "840"

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

language
String
Default Value: "00"

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.

name
String
Default Value: ""

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 and (Retail) or and (E-Commerce) must also be specified.

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

number
String
Default Value: ""

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.

phone
String
Default Value: ""

Merchant's phone number.

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

servicePhone
String
Default Value: ""

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.

state
String
Default Value: ""

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 and (Retail) or and (E-Commerce) must also be specified.

storeNumber
String
Default Value: ""

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.

streetAddress
String
Default Value: ""

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.

terminalNumber
String
Default Value: ""

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.

timeZone
String
Default Value: "705"

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

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

Byte #1:


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

Bytes #2-3:

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

zip
String
Default Value: ""

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.

Constructors

public init()

Config Settings (TSYSHealthCare Module)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

TSYSHealthCare Config Settings

AuthorizationIndicator: The type of authorization request.

This field defines the type of authorization request and must be included on all MasterCard authorization request transactions.

Valid values are:


Code	Description
P	Pre Authorization
F	Final Authorization
U	Undefined Authorization

CanadaDomesticIndicator: Canada Domestic Indicator.

Sending a value of "Y" in this Mastercard only field indicates the merchant accepts Canada domestic Debit Mastercard. This value must be sent in every Credit Authorization Request for merchants that accept Canada region-issued Debit Mastercard cards.

If Canada Domestic Indicator was present in the original transaction it must be included in a reversal message.

CITMITIndicator: CIT/MIT Indicator.

This 4-character field indicates whether the transaction was initiated by the Cardholder or the Merchant (Mastercard only).

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.

CumulativeAmount: Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only).

This configuration setting is required for Visa and Discover Incremental transaction. When supporting incremental authorizations, you must manually keep track of the sum of all authorizations made for a single transaction (all based on the same transaction id). This total will be sent on G3v022 (additional amounts) with amount type 43.

ECI: Electronic Commerce Indicator.

This contains a 1-character transaction indicator identifying the type of transaction being authorized. This is also known as "MOTO". This value is used only for Card Not Present transactions. See the table below for a list of supported values.


Indicator	Description
EMPTY ("")	Do not send Electronic Commerce Indicator in authorization request (ie: for Retail transactions)
SPACE (" ")	Not a Mail/Telephone Order Transaction (ie: for retail transactions).
1	One Time Occurrence of a Mail/Telephone Order Transaction (use for Direct Marketing).
2	Recurring Mail/Telephone Order Transaction.
3	Installment Payment of a Mail/Telephone Order Transaction.
4	Unknown Classification.
5	Secure Electronic Transaction (3-D Secure) and MasterCard SecureCode (UCAF)
6	Non-authenticated security transaction at a 3-D Secure capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure.
7	Non-authenticated Security Transaction, such as a Channel-Encrypted Transaction (default for CardNotPresent eCommerce transactions).
8	Non-secure Electronic Commerce Transaction
A	In-App Authentication (Discover, Mastercard and Amex)
R	First recurring SecureCode Phone Order transaction (Mastercard Only)
T	Single nonrecurring SecureCode Phone Order transaction (Mastercard Only)

Note: Other values necessary for passing 3D Secure data are CAVV and XID.

Note: Please make sure to send the SPACE (" ") value inside quotes. For Example:

TSYSRetail.Config("ECI=\" \"");

GatewayID: A unique value to identify a Gateway or Aggregator.

This 10 character field provides a unique value to identify a Gateway or Aggregator. This number is provided by TSYS Acquiring Solutions during the certification process.

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

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

HealthCareMemberData: Healthcare Member Data (Mastercard and Discover only).

This field can be up to 199 characters long and it can contain up to five sub-elements. Each sub-element describes one health service. Each sub-element may contain two Tag Length Value (TLV) data items that identify the health care provider (tag 1) and the specific service performed (tag 2).

Each sub-element starts with a two character sub-element id (01, 02, 03, 04, or 05), followed by a two-character length descriptor. The length descriptor tells how many data bytes follow in the sub-element.

Each item is comprised of:

TAG - two characters defining the sub-element ID (i.e. 01, 02, 03, etc.)
LENGTH - two characters defining the number of data characters that follow
VALUE - data value

For example if a clinic with two health providers (192387322 and 192782222) wishes to confirm eligibility for two services, 1A and V4. The following string would be submitted: 0119010919238732202021A021901091927822220202V4.

Note: For more details on Member Defined Data (G3v023) refer to TSYS EIS 1080 specs. class.Config("HealthCareMemberData=0119010919238732202021A021901091927822220202V4");

IncrementalApprovalCode: Transaction Approval Code associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the ResponseApprovalCode from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalRetrievalNumber: Transaction Retrieval Number associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the ResponseRetrievalNumber from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalTransDate: Transaction Date associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the ResponseTransmissionDate from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalTransId: Transaction Id associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the ResponseTransactionId from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IncrementalTransTime: Transaction Time associated with authorization to increment.

This configuration setting is required when sending an Incremental transaction, when the ACI is set to "I". It should be set with the ResponseTransactionTime from the original (first) authorization. You must keep track of the total authorized amount, which is the sum of the original authorization and all subsequent incremental authorizations, and set the TotalAuthorizedAmount configuration setting in the TSYSDetailRecord class before settlement. Only one detail record should be submitted, no matter how many incremental transactions are authorized.

IsMerchantInitiatedTransaction: Set this to process a Merchant Initiated transaction.

To process a Merchant Initiated Transaction you need to set this IsMerchantInitiatedTransaction flag to True. Default value is False.

IsPurchaseReturnAuthorization: Set this to process a Purchase Return Authorization transaction.

To process an online Purchase Return transaction you need to set this IsPurchaseReturnAuthorization flag to True. Default value is 'False'.

Note: To Reverse a Purchase Return Authorization you should use the TSYSReversal class and set the ReversalType to rtCreditAuthorization (5) before calling the Reverse method.

MastercardWalletId: Mastercard Wallet Identifier used to identify the Wallet Provider.

This 3-character value provides information about transactions initiated through the Masterpass Online platform or through the Mastercard Digital Enablement Service (MDES) and identifies the Wallet Provider. For MDES, Mastercard inserts the Wallet Identifier that is in the system, when available. For Masterpass, Mastercard passes the Wallet Identifier as sent in from the Point of Sale.

The following values apply to both Masterpass and MDES transactions:


Value	Description
101	Masterpass by Mastercard

The following values only apply to MDES transactions:


Value	Description
103	Apple Pay
216	Google Pay
217	Samsung Pay
327	Merchant tokenization program

Note: This value will be sent as part of G3v064 group in authorization request and as part of ODG41 group (Tag: "WID") in settlement.

MessageReasonCode: Code used to identify MIT or Deferred Authorizations for Visa.

This field is used to identify Merchant Initiated or Deferred Authorizations for Visa.

Merchant Initiated Transactions A Merchant Initiated Transaction (MIT) is any transaction that relates to the previous consumer-initiated transaction but is conducted without the consumer being present and without any cardholder validation performed. Valid values are:


Code	Description
3900	Incremental Authorization (this is a continuation of the consumer purchase)
3901	Resubmission (valid when the original authorization was declined for insufficient funds)
3902	Delayed Charges (account charge associated with an agreement between a cardholder and a merchant for services rendered)
3903	Reauthorization (purchase made after the original purchase such as: split shipment, estimated amount etc.)
3904	No Show (when the customer did not meet the terms of the agreement and the merchant is able to charge for it)

Deferred Authorizations If the merchant's Point-of-Interaction (POI) authorization system is offline and cannot process transactions, the merchant often completes the transaction with the cardholder and will then defer the authorization until their POI system is back online. Valid value is:


Code	Description
5206	Deferred Authorization

MITTransactionId: Transaction Id associated with the original authorization of a Merchant Initiated Transaction.

This configuration setting is required when sending an Merchant Initiated Transaction, when the IsMerchantInitiatedTransaction is set to 'True'. It should be set with the ResponseTransactionId from the original (first) authorization. This configuration setting is required when sending MIT Recurring, MIT Installment, MIT Standing Instruction or MIT Industry Practice transactions. To send an MIT Standing Instruction you need to set the POSEnvironmentIndicator to specify the type of merchant initiated transaction. To send an MIT Industry Practice you need to set the MessageReasonCode to specify the reason for this merchant initiated transaction.

Note: For Merchant Initiated Transactions you need to set the POSDataCode.CardInputMode to '7'.

MPGID: Merchant Payment Gateway ID.

The Merchant Payment Gateway Identifier (MPGID) is a unique value that is generated and provisioned by Mastercard. Payment gateways must register directly with Mastercard to obtain a unique value, and include it on the incoming authorization message. Maximum length for this field is 11 digits.

Port: The port to which transactions are posted.

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

POSDataCode: Specifies the condition of the POS device used at the time of the transaction.

This configuration setting takes a semi-colon separated list of name-value pairs. The available field names and their applicable values can be found below. The fields can be set in any order and not all fields are required to be set (unless you wish to change their default values).

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 class will not update the POSDataCode tag in the detail aggregate of the original transaction.

POSEnvironmentIndicator: Provides additional information about the transaction for Visa.

This Visa only configuration setting is used to provide additional information about the transaction. This value should be set in the following scenarios with the respective values:


Value	Description
C	Card On File
I	Installment Payment
R	Recurring Payment

Note: If the merchant stores payment credential for the first time, the value in POSDataCode.CardInputMode should reflect the actual entry mode for the transaction (i.e. manual input, key entered).

If the merchant initiates a transaction using a stored payment credential, the value in POSDataCode.CardInputMode should be '7' for Credential on File transactions.

ResponseTransactionIntegrityClass: A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class.

This read-only configuration setting contains a 2-character value when returned in the response of MasterCard Credit transactions. This value encompasses the fundamental safety and security of credit transactions, including the assessment of both the validity of the card and the cardholder.

Server: The server to which transactions are posted.

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

TLID: Transaction Link Identifier.

The Transaction Link Identifier (TLID) is used to track the life cycle of activity occurring after the original transaction and other related transactions. The TLID will be returned by Mastercard in the authorization response message. The returned value will also be present in the aggregate returned from the GetDetailAggregate method and for all subsequent transactions that utilize the aggregate (such as reversals, incrementals, settlement) the value will be automatically included in the request. When not utilizing the aggregate, you may explicitly set this config with the TLID value that was saved when the original transaction was performed.

TCPClient Config Settings

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

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

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

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

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

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

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

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

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

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

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

FirewallPort: The TCP port for the FirewallHost;.

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

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

FirewallType: Determines the type of firewall to connect through.

The appropriate values are as follows:


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

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

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

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

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

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

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

Note: This value is not applicable in macOS.

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

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

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

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

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

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

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

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

LingerTime: Time in seconds to have the connection linger.

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

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

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

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

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

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

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

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

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

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

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

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

MaxTransferRate: The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6: Whether to use IPv6.

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


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

SSL Config Settings

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

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

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

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

ReuseSSLSession: Determines if the SSL session is reused.

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

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

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

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

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

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class .

When set to 0 (default) the CRL check will not be performed by the class. 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.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class .

When set to 0 (default) the class 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.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

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

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

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

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

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internal:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

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

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30) [Platform Only]
SSL2	12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

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

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

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

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

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

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

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

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

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

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

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

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

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

SSLNegotiatedCipher: Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

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

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

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

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

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

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

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

SSLNegotiatedVersion: Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

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

SSLSecurityFlags: Flags that control certificate verification.

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


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.

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

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

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

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class .

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

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

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

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

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

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

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

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

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

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

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

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

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

Socket Config Settings

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

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

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

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

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

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

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

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

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

The following is a list of valid code page identifiers:


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

The following is a list of valid code page identifiers for Mac OS only:


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

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

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

Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (TSYSHealthCare Module)

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

TCPClient Errors


	100 You cannot change the RemotePort at this time. A connection is in progress.
	101 You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102 The RemoteHost address is invalid (0.0.0.0).
	104 Already connected. If you want to reconnect, close the current connection first.
	106 You cannot change the LocalPort at this time. A connection is in progress.
	107 You cannot change the LocalHost at this time. A connection is in progress.
	112 You cannot change MaxLineLength at this time. A connection is in progress.
	116 RemotePort cannot be zero. Please specify a valid service port number.
	117 You cannot change the UseConnection option while the class is active.
	135 Operation would block.
	201 Timeout.
	211 Action impossible in control's present state.
	212 Action impossible while not connected.
	213 Action impossible while listening.
	301 Timeout.
	302 Could not open file.
	434 Unable to convert string to selected CodePage.
	1105 Already connecting. If you want to reconnect, close the current connection first.
	1117 You need to connect first.
	1119 You cannot change the LocalHost at this time. A connection is in progress.
	1120 Connection dropped by remote host.

SSL Errors


	270 Cannot load specified security library.
	271 Cannot open certificate store.
	272 Cannot find specified certificate.
	273 Cannot acquire security credentials.
	274 Cannot find certificate chain.
	275 Cannot verify certificate chain.
	276 Error during handshake.
	280 Error verifying certificate.
	281 Could not find client certificate.
	282 Could not find server certificate.
	283 Error encrypting data.
	284 Error decrypting data.

TCP/IP Errors


	10004 [10004] Interrupted system call.
	10009 [10009] Bad file number.
	10013 [10013] Access denied.
	10014 [10014] Bad address.
	10022 [10022] Invalid argument.
	10024 [10024] Too many open files.
	10035 [10035] Operation would block.
	10036 [10036] Operation now in progress.
	10037 [10037] Operation already in progress.
	10038 [10038] Socket operation on non-socket.
	10039 [10039] Destination address required.
	10040 [10040] Message too long.
	10041 [10041] Protocol wrong type for socket.
	10042 [10042] Bad protocol option.
	10043 [10043] Protocol not supported.
	10044 [10044] Socket type not supported.
	10045 [10045] Operation not supported on socket.
	10046 [10046] Protocol family not supported.
	10047 [10047] Address family not supported by protocol family.
	10048 [10048] Address already in use.
	10049 [10049] Can't assign requested address.
	10050 [10050] Network is down.
	10051 [10051] Network is unreachable.
	10052 [10052] Net dropped connection or reset.
	10053 [10053] Software caused connection abort.
	10054 [10054] Connection reset by peer.
	10055 [10055] No buffer space available.
	10056 [10056] Socket is already connected.
	10057 [10057] Socket is not connected.
	10058 [10058] Can't send after socket shutdown.
	10059 [10059] Too many references, can't splice.
	10060 [10060] Connection timed out.
	10061 [10061] Connection refused.
	10062 [10062] Too many levels of symbolic links.
	10063 [10063] File name too long.
	10064 [10064] Host is down.
	10065 [10065] No route to host.
	10066 [10066] Directory not empty
	10067 [10067] Too many processes.
	10068 [10068] Too many users.
	10069 [10069] Disc Quota Exceeded.
	10070 [10070] Stale NFS file handle.
	10071 [10071] Too many levels of remote in path.
	10091 [10091] Network subsystem is unavailable.
	10092 [10092] WINSOCK DLL Version out of range.
	10093 [10093] Winsock not loaded yet.
	11001 [11001] Host not found.
	11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004 [11004] Valid name, no data record (check DNS setup).