TSYSHCECommerce Module

Properties Methods Events Config Settings Errors

The TSYSHCECommerce module is used to authorize credit cards in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet. This module makes authorizing these types of transactions very easy.

Syntax

DPaymentsSDK.Tsyshcecommerce

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 TSYSHCECommerce class makes authorizing Card-Not-Present Mail Order and E-Commerce transactions very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

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

TSYSHCECommerce1.GenKey = "gen_key_value" TSYSHCECommerce1.MerchantId = "merchant_id" TSYSHCECommerce1.RoutingId = "routing_id"

Then, set the customer's credit card information, as well as his address and zip code (the address and zip code will be checked by the Vital/TSYS servers to make sure it matches the customer's billing address).

TSYSHCECommerce1.CardNumber = "4444333322221111" TSYSHCECommerce1.CardExpMonth = 1 TSYSHCECommerce1.CardExpYear = 2013 TSYSHCECommerce1.CardCVVData = "999" TSYSHCECommerce1.CustomerAddress = "8320 South Hardy Dr." TSYSHCECommerce1.CustomerZip = "85284"

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount and TransactionNumber. However, you may also set the TransactionType if you are doing a Mail Order or Recurring transaction.

TSYSHCECommerce1.TransactionNumber = 1 TSYSHCECommerce1.TransactionAmount = "100" TSYSHCECommerce1.TransactionType = ttECommerce

Finally, submit the transaction by calling one of four authorization methods. Sale, Credit, AuthenticateCard or BalanceInquiry. The following code demonstrates a purchase: TSYSHCECommerce1.Sale()

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 remaining properties provide additional information about the transaction.

Once a credit card Sale or Credit is approved and is added to the current batch. The transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr class.

Note: The TSYSHCECommerce class can be used to pass 3D-Secure and MasterCard SecureCode authentication data in an authorization to achieve a better interchange rate. To send this data, the ECI, XID and CAVV (3D-Secure), UCAFCollectionIndicator, UCAFSecurityIndicator and UCAFData (MasterCard SecureCode) configuration variables must be set before calling Sale. The CAVV and UCAF authentication result code will be returned in the ResponseCAVV and ResponseUCAF configuration settings, respectively. For Mastercard Identity Check transactions you must set the ProgramProtocol and DirectoryServerTxnID configs.

Property List

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


CaptureMode	The capture mode to be used when performing an authorization or adjustment.
Card	Contains the customer's credit card information.
ClearingSequenceCount	The total number of installment payments.
ClearingSequenceNumber	The payment number of the total number of installment payments.
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
GenKey	The unique GenKey value used to identify a POS device.
GoodsIndicator	Used to identify the type of goods purchased over the Internet.
GratuityAmount	The gratuity (tip) amount of the transaction.
InvoiceNumber	Invoice number for the purchase.
Level2	Level2 Corporate Purchasing Card data.
MerchantCategoryCode	Classifies a merchant by the type of store.
MerchantId	The unique ID that associates the POS device with the merchant account.
RepeatIndicator	Indicates whether a transaction is a repeat of a previous transaction attempt.
Response	Contains the response to an authorization request.
RoutingId	The Routing ID assigned to the merchant by TSYS.
SSLAcceptServerCertEncoded	This is the certificate (PEM/Base64 encoded).
SSLCertEncoded	This is the certificate (PEM/Base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/Base64 encoded).
Timeout	A timeout for the module.
TransactionAmount	Purchase amount to be authorized.
TransactionDesc	Soft (Dynamic) Descriptor.
TransactionNumber	Sequence number of this transaction.
TransactionType	The type of e-commerce transaction.

Method List

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


AdjustTip	Sends a tip adjustment request.
AuthenticateCard	Sends an authentication (authorization only) request which will not be captured.
BillPayment	Sends a bill payment request.
Config	Sets or retrieves a configuration setting.
Credit	Sends a credit request.
Force	Performs an offline authorization request.
Interrupt	Interrupts the current action.
Reset	Clears all properties to their default values.
Sale	Sends a sale/purchase request.
VoidTransaction	Sends a void request.

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.


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.


AllowPartialAuths	Indicates whether partial authorizations are to be supported.
AlternateMerchantName	Contains an alternate merchant/DBA name.
AuthorizationIndicator	The type of authorization request.
CAVV	AuthenticationCAVV data from the ThreeDSecure module.
DigitalPaymentCryptogram	Digital Payment Cryptogram used for DSRP transactions (Mastercard only).
DirectoryServerTxnID	Directory Server Transaction ID generated by the EMV 3DS Mastercard Directory Server during authentication (Mastercard only).
ECI	Electronic Commerce Indicator.
ISOIdentifier	ISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover.
Language	Indicates the language to be used in formatting the authorization response text message.
LocationDetailCity	Location Detail City.
LocationDetailCountry	The Payment Facilitator Sub-Merchant Country Code.
LocationDetailName	Location Detail Name.
LocationDetailPostalCode	The Payment Facilitator Sub-Merchant Postal Code.
LocationDetailState	The Payment Facilitator Sub-Merchant State/Province Code.
OriginalAmount	The Original Amount related to a previous Consumer Initiated Transaction (Discover only).
PFForeignRetailerIndicator	The Payment Facilitator Foreign Retailer Indicator (Visa only).
PFIdentifier	The Payment Facilitator/Marketplace Identifier.
POSAcceptanceDeviceType	Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions.
POSAuthEntity	The authentication entity to indicate the circumstances in which card data was entered at the POS.
POSCardCaptureCapability	Card capture capability data to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthCapability	Cardholder authentication capability data to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthMethod	Cardholder authentication method to indicate the circumstances in which card data was entered at the POS.
POSCardholderPresent	Cardholder present data to indicate the circumstances in which card data was entered at the POS.
POSCardInputCapability	Card input capability data to indicate the circumstances in which card data was entered at the POS.
POSCardInputMode	Card input mode to indicate the circumstances in which card data was entered at the POS.
POSCardOutputCapability	Card output capability data to indicate the circumstances in which card data was entered at the POS.
POSCardPresent	Card present data to indicate the circumstances in which card data was entered at the POS.
POSChipConditionCode	Chip condition code to indicate the circumstances in which card data was entered at the POS.
POSCITMITIndicator	CIT/MIT Indicator.
POSEnvironmentIndicator	Provides additional information about the transaction.
POSOperatingEnvironment	Operating environment data to indicate the circumstances in which card data was entered at the POS.
POSPINCaptureCapability	PIN capture capability data to indicate the circumstances in which card data was entered at the POS.
POSTerminalOutputCapability	Terminal output capability data to indicate the circumstances in which card data was entered at the POS.
POSTransactionStatus	A 1-character value used to indicate the purpose or status of the request.
ProgramProtocol	Identifies the version of the EMV 3D-Secure protocol (Mastercard only).
RawRequest	Returns the request sent to the server for debugging purposes.
RawResponse	Returns the response received from the server for debugging purposes.
RequestToken	Indicates whether to request a token for the specified card data sent in an Authorize request.
ResponseCAVV	Used for 3D-Secure transactions. Indicates whether the submitted CAVV value passed validation.
ResponseUCAF	Used for MasterCard SecureCode transactions to indicate whether MasterCard downgraded the SecureCode transaction and sent it to the Issuer.
RetrieveToken	Sends a Token Only request.
ServerURL	The server to which transactions are posted.
SubMerchantIdentifier	The Payment Facilitator Sub-Merchant Identifier.
SurchargeAmount	The transaction fee amount charged to the customer to account for acquirer-assessed surcharge.
Token	The token received from the TSYS host when a token request is sent.
UCAFCollectionIndicator	Indicates the merchant's support and usage of UCAF in MasterCard SecureCode transactions.
UCAFData	UCAF Authentication data from the MasterCard SecureCode authentication.
UCAFSecurityIndicator	Indicates the security level and cardholder authentication in MasterCard SecureCode transactions.
XID	TransactionId from a 3D Secure authentication.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the module.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the module will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the module.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the module.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the 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.

CaptureMode Property (TSYSHCECommerce Module)

The capture mode to be used when performing an authorization or adjustment.

public var captureMode: TsyshcecommerceCaptureModes {
  get {...}
  set {...}
}

public enum TsyshcecommerceCaptureModes: Int32 {
  case cmNormal = 0
  case cmDelay = 1
  case cmHold = 2
  case cmCapture = 3
}


@property (nonatomic,readwrite,assign,getter=captureMode,setter=setCaptureMode:) int captureMode;

- (int)captureMode;
- (void)setCaptureMode :(int)newCaptureMode;

Default Value

Remarks

This property is used to specify the capture mode to be used when performing an authorization or an adjustment transaction.

Possible values are:


Normal (0)	The transaction will be added to the current batch, as specified by BatchNumber, if successfully authorized.
Delay (1)	Indicates that the transaction should not be captured in the current batch without adjustment. If the transaction is adjusted before the current batch closes, then the transaction will be captured in the current batch. If the transaction is not adjusted before the current batch closes, the transaction will be captured in the next batch with or without adjustment.
Hold (2)	When Hold is specified in an original authorization transaction, it will be excluded from batch closing processing.
Capture (3)	When Capture is specified in an adjustment transaction, the batch processing exclusion will be removed in which the transaction will be captured in the current batch.

If you wish to add Level 3 data, you will want to set CaptureMode to Delay (1) when issuing the initial authorization. Then once the Level 3 request is successfully issued, the transaction will be captured in the next batch close event.

Note: To use the Hold and Capture modes, the merchant must be established as a Hold Capture participant.

Note: To use the Delay mode, the merchant must be established as a Delay Capture participant.

Card Property (TSYSHCECommerce Module)

Contains the customer's credit card information.

Syntax

Swift
Objective-C

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.

ClearingSequenceCount Property (TSYSHCECommerce Module)

The total number of installment payments.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=clearingSequenceCount,setter=setClearingSequenceCount:) int clearingSequenceCount;

- (int)clearingSequenceCount;
- (void)setClearingSequenceCount :(int)newClearingSequenceCount;

Default Value

Remarks

This property is used when processing installment payments to specify the total number of transactions in the sequence.

Below is an example of using installment payments (for a total of 3 payments) and what ClearingSequenceNumber and ClearingSequenceCount should be set to for each payment.


Record	ClearingSequenceNumber	ClearingSequenceCount
First Payment of 3	1	3
Second Payment of 3	2	3
Third Payment of 3	3	3

ClearingSequenceNumber Property (TSYSHCECommerce Module)

The payment number of the total number of installment payments.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=clearingSequenceNumber,setter=setClearingSequenceNumber:) int clearingSequenceNumber;

- (int)clearingSequenceNumber;
- (void)setClearingSequenceNumber :(int)newClearingSequenceNumber;

Default Value

Remarks

This property is used to specify the payment number that the current payment represents in the total count of installment payments to be made (represented by ClearingSequenceCount).

Below is an example of using installment payments (for a total of 3 payments) and what ClearingSequenceNumber and ClearingSequenceCount should be set to for each payment.


Record	ClearingSequenceNumber	ClearingSequenceCount
First Payment of 3	1	3
Second Payment of 3	2	3
Third Payment of 3	3	3

CustomerAddress Property (TSYSHCECommerce 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 (TSYSHCECommerce 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.

GenKey Property (TSYSHCECommerce Module)

The unique GenKey value used to identify a POS device.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=genKey,setter=setGenKey:) NSString* genKey;

- (NSString*)genKey;
- (void)setGenKey :(NSString*)newGenKey;

Default Value

Remarks

This property is used to specify the unique GenKey value used to identify the POS device to the host capture system. This property is required to be specified in every transaction performed.

Your GenKey value is obtained from the host capture system when you successfully authenticate your POS device, which can be accomplished by calling AuthenticateDevice. Once retrieved, your GenKey value must be stored in the POS device.

GoodsIndicator Property (TSYSHCECommerce Module)

Used to identify the type of goods purchased over the Internet.

Syntax

Swift
Objective-C

public var goodsIndicator: TsyshcecommerceGoodsIndicators {
  get {...}
  set {...}
}

public enum TsyshcecommerceGoodsIndicators: Int32 {
  case tgiNotUsed = 0
  case tgiDigitalGoods = 1
  case tgiPhysicalGoods = 2
}


@property (nonatomic,readwrite,assign,getter=goodsIndicator,setter=setGoodsIndicator:) int goodsIndicator;

- (int)goodsIndicator;
- (void)setGoodsIndicator :(int)newGoodsIndicator;

Default Value

Remarks

This property is used to identify the type of goods purchased over the Internet. Supported types are shown below.


tgiNotUsed (0)	GoodsIndicator is not used.
tgiDigitalGoods (1)	Customer purchased digital goods (for instance, an application that was electronically delivered).
tgiPhysicalGoods (2)	Customer purchased actual physical goods, which were then shipped to the customer.

GratuityAmount Property (TSYSHCECommerce Module)

The gratuity (tip) amount of the transaction.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=gratuityAmount,setter=setGratuityAmount:) NSString* gratuityAmount;

- (NSString*)gratuityAmount;
- (void)setGratuityAmount :(NSString*)newGratuityAmount;

Default Value

Remarks

This property is used to specify the gratuity (tip) amount when performing an authorization via Authorize.

InvoiceNumber Property (TSYSHCECommerce Module)

Invoice number for the purchase.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=invoiceNumber,setter=setInvoiceNumber:) NSString* invoiceNumber;

- (NSString*)invoiceNumber;
- (void)setInvoiceNumber :(NSString*)newInvoiceNumber;

Default Value

Remarks

This property is used to specify the merchant assigned invoice number for the e-Commerce (card not present) purchase.

Level2 Property (TSYSHCECommerce Module)

Level2 Corporate Purchasing Card data.

Syntax

Swift
Objective-C

public var level2: TSYSHCLevel2 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=level2AmexChargeDescriptor,setter=setLevel2AmexChargeDescriptor:) NSString* level2AmexChargeDescriptor;

- (NSString*)level2AmexChargeDescriptor;
- (void)setLevel2AmexChargeDescriptor :(NSString*)newLevel2AmexChargeDescriptor;

@property (nonatomic,readwrite,assign,getter=level2AmexChargeDescriptor2,setter=setLevel2AmexChargeDescriptor2:) NSString* level2AmexChargeDescriptor2;

- (NSString*)level2AmexChargeDescriptor2;
- (void)setLevel2AmexChargeDescriptor2 :(NSString*)newLevel2AmexChargeDescriptor2;

@property (nonatomic,readwrite,assign,getter=level2AmexChargeDescriptor3,setter=setLevel2AmexChargeDescriptor3:) NSString* level2AmexChargeDescriptor3;

- (NSString*)level2AmexChargeDescriptor3;
- (void)setLevel2AmexChargeDescriptor3 :(NSString*)newLevel2AmexChargeDescriptor3;

@property (nonatomic,readwrite,assign,getter=level2AmexChargeDescriptor4,setter=setLevel2AmexChargeDescriptor4:) NSString* level2AmexChargeDescriptor4;

- (NSString*)level2AmexChargeDescriptor4;
- (void)setLevel2AmexChargeDescriptor4 :(NSString*)newLevel2AmexChargeDescriptor4;

@property (nonatomic,readwrite,assign,getter=level2AmexRequesterName,setter=setLevel2AmexRequesterName:) NSString* level2AmexRequesterName;

- (NSString*)level2AmexRequesterName;
- (void)setLevel2AmexRequesterName :(NSString*)newLevel2AmexRequesterName;

@property (nonatomic,readwrite,assign,getter=level2AmexShippedToZip,setter=setLevel2AmexShippedToZip:) NSString* level2AmexShippedToZip;

- (NSString*)level2AmexShippedToZip;
- (void)setLevel2AmexShippedToZip :(NSString*)newLevel2AmexShippedToZip;

@property (nonatomic,readwrite,assign,getter=level2IsTaxExempt,setter=setLevel2IsTaxExempt:) BOOL level2IsTaxExempt;

- (BOOL)level2IsTaxExempt;
- (void)setLevel2IsTaxExempt :(BOOL)newLevel2IsTaxExempt;

@property (nonatomic,readwrite,assign,getter=level2PurchaseOrderNumber,setter=setLevel2PurchaseOrderNumber:) NSString* level2PurchaseOrderNumber;

- (NSString*)level2PurchaseOrderNumber;
- (void)setLevel2PurchaseOrderNumber :(NSString*)newLevel2PurchaseOrderNumber;

@property (nonatomic,readwrite,assign,getter=level2TaxAmount,setter=setLevel2TaxAmount:) NSString* level2TaxAmount;

- (NSString*)level2TaxAmount;
- (void)setLevel2TaxAmount :(NSString*)newLevel2TaxAmount;

Default Value

Remarks

This property allows you to specify Corporate Purchasing Card data to create Level2 transactions. The TSYSHCLevel2 type contains the following fields:


	The name of the requestor, if different than the cardholder. (AMEX Level2 only)
	The zip code to which the commodity was shipped. (AMEX Level2 only)
	Description of this transaction. (AMEX Level2 only)
	Description of this transaction. (AMEX Level2 only)
	Description of this transaction. (AMEX Level2 only)
	Description of this transaction. (AMEX Level2 only)
	Identifies the tax exempt status of the purchasing card. (VISA and MasterCard)
	Optional customer-specified purchase order number. (VISA and MasterCard)
	Sales tax charged in addition to the original TransactionAmount. (VISA and MasterCard)

MerchantCategoryCode Property (TSYSHCECommerce Module)

Classifies a merchant by the type of store.

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

MerchantId Property (TSYSHCECommerce Module)

The unique ID that associates the POS device with the merchant account.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=merchantId,setter=setMerchantId:) NSString* merchantId;

- (NSString*)merchantId;
- (void)setMerchantId :(NSString*)newMerchantId;

Default Value

Remarks

The unique ID, also known as the POS ID, that associates the POS device with the merchant account.

This property is required to be specified in every transaction performed.

RepeatIndicator Property (TSYSHCECommerce Module)

Indicates whether a transaction is a repeat of a previous transaction attempt.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=repeatIndicator,setter=setRepeatIndicator:) BOOL repeatIndicator;

- (BOOL)repeatIndicator;
- (void)setRepeatIndicator :(BOOL)newRepeatIndicator;

Default Value

False

Remarks

This property allows you to specify whether a transaction is a repeat of a previous transaction attempt.

If a timeout exception occurs, such as the host capture system not receiving the request or the response not being received from the host capture system, you can set RepeatIndicator to true and resend the request using the original transaction details. In the case that the host capture system received the original transaction, it has already been logged and will respond with existing Response details. In the case that the host capture system did not receive the original transaction, it will process the request normally.

Note: Repeat transactions are not allowed for gift card and debit transactions.

Response Property (TSYSHCECommerce Module)

Contains the response to an authorization request.

Syntax

Swift
Objective-C

public var response: TSYSHCResponse {
  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=responseAVSResult) NSString* responseAVSResult;

- (NSString*)responseAVSResult;

@property (nonatomic,readonly,assign,getter=responseBatchNumber) int responseBatchNumber;

- (int)responseBatchNumber;

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

- (NSString*)responseCardType;

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

- (NSString*)responseCode;

@property (nonatomic,readonly,assign,getter=responseCommercialCardType) int responseCommercialCardType;

- (int)responseCommercialCardType;

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

- (NSString*)responseCVVResult;

@property (nonatomic,readonly,assign,getter=responseInstallmentAdvice) int responseInstallmentAdvice;

- (int)responseInstallmentAdvice;

@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;

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 TSYSHCResponse type contains the following fields:


	The partial authorized amount.
	Contains the incrementing ID assigned by TSYS to identify a merchant batch.
	The type of card sent in the authorization request.
	Indicates the status of the authorization request.
	Response field that indicates whether the card is a commercial card.
	Contains an authorization code when a transaction has been approved.
	Contains the Address Verification System result code.
	Contains the returned CVV result code if it was requested.
	This number is to be used to identify transactions and should be submitted when making adjustments, 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.
	Local transaction time returned from the server in HHMMSS format.
	Contains the Transaction Identifier or MasterCard Reference Number.
	Check this field against the original Transaction Number.
	Contains the Merchant Advice Code returned by MasterCard MIP.

RoutingId Property (TSYSHCECommerce Module)

The Routing ID assigned to the merchant by TSYS.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=routingId,setter=setRoutingId:) NSString* routingId;

- (NSString*)routingId;
- (void)setRoutingId :(NSString*)newRoutingId;

Default Value

Remarks

This property is used to specify the six alphanumeric character routing ID assigned to you via TSYS.

This property is required to be set for every transaction request.

SSLAcceptServerCertEncoded Property (TSYSHCECommerce 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 (TSYSHCECommerce 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 (TSYSHCECommerce 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 (TSYSHCECommerce 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 (TSYSHCECommerce Module)

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

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

public enum TsyshcecommerceSSLCertStoreTypes: 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 (TSYSHCECommerce 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 (TSYSHCECommerce Module)

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

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

public enum TsyshcecommerceSSLProviders: 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 (TSYSHCECommerce 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

Timeout Property (TSYSHCECommerce 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).

TransactionAmount Property (TSYSHCECommerce 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 t transaction amount; is "9999999", yielding a US dollar amount of $99,999.99.

Note: This field may not contain a negative number.

TransactionDesc Property (TSYSHCECommerce Module)

Soft (Dynamic) Descriptor.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=transactionDesc,setter=setTransactionDesc:) NSString* transactionDesc;

- (NSString*)transactionDesc;
- (void)setTransactionDesc :(NSString*)newTransactionDesc;

Default Value

Remarks

This property allows a merchant to specify a description about the transaction.

The maximum length of this property is 25 characters (alphanumeric and special characters).

TransactionNumber Property (TSYSHCECommerce 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 number must be unique, it's used to identify the transaction in order to operate on it in the future.

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages.

The maximum length of this property is 8 characters.

TSYS suggests the following application rules for the format of TransactionNumber:

Format the TransactionNumber as "DDSSS", where DD is the current day of the month and SSS is a sequence of numbers from 001-999.
Configure the sequence number for 2-5 positions so the sequence number can increment through a single day without rolling over.
Allow the sequence to increment and roll-over. Do not program the TransactionNumber to reset when a batch close occurs.

TransactionType Property (TSYSHCECommerce Module)

The type of e-commerce transaction.

Syntax

Swift
Objective-C

public var transactionType: TsyshcecommerceTransactionTypes {
  get {...}
  set {...}
}

public enum TsyshcecommerceTransactionTypes: Int32 {
  case dmtECommerce = 0
  case dmtMOTO = 1
  case dmtRecurring = 2
  case dmtInstallment = 3
}


@property (nonatomic,readwrite,assign,getter=transactionType,setter=setTransactionType:) int transactionType;

- (int)transactionType;
- (void)setTransactionType :(int)newTransactionType;

Default Value

Remarks

This property allows you to specify the type of e-commerce transaction that you are performing. Valid values are:


dmtECommerce (0)	E-Commerce transaction.
dmtMOTO (1)	One time Mail Order or Telephone Order transaction.
dmtRecurring (2)	Recurring Mail/Telephone Order transaction.
dmtInstallment (3)	Installment payment. For example, "Three easy payments of $19.95". Installment details are specified using ClearingSequenceCount and ClearingSequenceNumber

AdjustTip Method (TSYSHCECommerce Module)

Sends a tip adjustment request.

Syntax

Swift
Objective-C

public func adjustTip(retrievalNumber: String, originalAmount: String, tipAmount: String) throws -> Void

- (void)adjustTip:(NSString*)retrievalNumber :(NSString*)originalAmount :(NSString*)tipAmount;

Remarks

Sends a tip adjustment request, which allows you to add a tip amount to the transaction specified by RetrievalNumber. Response will contain additional details about the tip adjustment request.

Method parameters are:


RetrievalNumber	The ResponseRetrievalNumber from the previously authorized transaction.
OriginalAmount	The original authorized amount.
TipAmount	The tip amount that you want to add to the transaction.

Minimum required properties:

GenKey
MerchantId
RoutingId

Note: To use the TransactionNumber instead of the returned ResponseRetrievalNumber to void the transaction, you can set RetrievalNumber to "" (empty string) and the value contained within TransactionNumber will be used instead.

AuthenticateCard Method (TSYSHCECommerce Module)

Sends an authentication (authorization only) request which will not be captured.

Syntax

Swift
Objective-C

public func authenticateCard() throws -> Void

- (void)authenticateCard;

Remarks

This method sends an authorization only request to the Vital/TSYS transaction server which is used to authenticate a card. The transaction will only be authorized and will not be captured. If the authorization request was successful, the ResponseCode property will contain "85". Response will contain additional details about the authorization request.

Minimum required properties:

GenKey
MerchantId
RoutingId
Card
TransactionAmount
TransactionNumber

BillPayment Method (TSYSHCECommerce Module)

Sends a bill payment request.

Syntax

Swift
Objective-C

public func billPayment() throws -> Void

- (void)billPayment;

Remarks

This method sends a bill payment request to the Vital/TSYS transaction server. If the bill payment request was successful, the ResponseCode property will contain "00" or "10". Response will contain additional details about the purchase request.

Minimum required properties:

GenKey
MerchantId
RoutingId
Card
TransactionAmount
TransactionNumber

Config Method (TSYSHCECommerce 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.

Credit Method (TSYSHCECommerce Module)

Sends a credit request.

Syntax

Swift
Objective-C

public func credit() throws -> Void

- (void)credit;

Remarks

This method sends a credit request to the Vital/TSYS transaction server. If the credit request was successful, the ResponseCode property will contain "00". Response will contain additional details about the credit request.

Minimum required properties:

GenKey
MerchantId
RoutingId
Card
TransactionAmount
TransactionNumber

Force Method (TSYSHCECommerce Module)

Performs an offline authorization request.

Syntax

Swift
Objective-C

public func force(approvalCode: String, transactionDate: String, transactionTime: String) throws -> Void

- (void)force:(NSString*)approvalCode :(NSString*)transactionDate :(NSString*)transactionTime;

Remarks

Sends an offline authorization request, which stores the transaction, that was authorized elsewhere, on the Host Capture system for capture. Response will contain additional details about the authorization request.

Method parameters are:


ApprovalCode	The authorization code received from the call center.
TransactionDate	The transaction date calculated by the authorization center, formatted as "MMDDYY".
TransactionTime	The transaction time returned by the authorizing system, formatted as "HHMMSS".

Minimum required properties:

GenKey
MerchantId
RoutingId
Card
TransactionAmount
TransactionNumber

Interrupt Method (TSYSHCECommerce 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 (TSYSHCECommerce 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.

Sale Method (TSYSHCECommerce Module)

Sends a sale/purchase request.

Syntax

Swift
Objective-C

public func sale() throws -> Void

- (void)sale;

Remarks

This method sends a sale/purchase request to the Vital/TSYS transaction server. If the sale request was successful, the ResponseCode property will contain "00" or "10". Response will contain additional details about the purchase request.

Minimum required properties:

GenKey
MerchantId
RoutingId
Card
TransactionAmount
TransactionNumber

VoidTransaction Method (TSYSHCECommerce Module)

Sends a void request.

Syntax

Swift
Objective-C

public func voidTransaction(retrievalNumber: String, originalAmount: String) throws -> Void

- (void)voidTransaction:(NSString*)retrievalNumber :(NSString*)originalAmount;

Remarks

This method sends a void request to the Vital/TSYS transaction server. If the authorization request was successful, the ResponseCode property will contain "200". Response will contain additional details about the authorization request.

Method parameters are:


RetrievalNumber	The ResponseRetrievalNumber from the previously authorized transaction.
OriginalAmount	The original authorized amount.

Minimum required properties:

GenKey
MerchantId
RoutingId

Note either RetrievalNumber or TransactionNumber may be used to reference the transaction that is to be retrieved, adjusted or voided. If both are supplied, the RetrievalNumber will be used and the TransactionNumber ignored.

In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.

Error Event (TSYSHCECommerce 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 (TSYSHCECommerce 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 (TSYSHCECommerce 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: )

TSYSHCLevel2 Type

Contains the Corporate Purchasing Card data to create Level2 transactions.

Remarks

Contains the Corporate Purchasing Card data to create Level2 transactions.The properties contained by this type are listed below.

Fields

amexChargeDescriptor
String
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

amexChargeDescriptor2
String
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

amexChargeDescriptor3
String
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

amexChargeDescriptor4
String
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

amexRequesterName
String
Default Value: ""

The name of the requestor, if different than the cardholder.

This property contains the name of the requester, if the Card member is not the person that ordered or purchased the product or service.

The maximum length for this field is 38 characters.

amexShippedToZip
String
Default Value: ""

The zip code to which the commodity was shipped.

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place. This is only used when sending Level II data for an American Express purchasing card.

The maximum length for this property is 6 characters.

isTaxExempt
Bool
Default Value: False

Identifies the characteristics of the amount appearing in and allows you to indicate whether the purchasing card qualifies for tax-exempt status.

When set to "True", the purchasing card will be indicated as being tax-exempt. When set to "False", the amount of will be indicated as being Local Sales Tax.

Note: This property cannot be set to "True" if there is a set.

purchaseOrderNumber
String
Default Value: ""

Optional customer-specified purchase order number.

This property contains a Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder. The maximum length is 25 characters.

taxAmount
String
Default Value: ""

Sales tax charged in addition to the original TransactionAmount

Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

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.

Constructors

public init()

TSYSHCResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of an authorization transaction made with the TSYSHCRetail or TSYSHCECommerce 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: ""

The partial authorized amount.

This property will be populated with the partial authorized amount. If the transaction is not a partial authorization, this property will be "" (empty string).

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

batchNumber
Int32 (read-only)
Default Value: 0

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.

Note that if CaptureMode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See CaptureMode for more details.

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

The type of card sent in the authorization request.

Possible values are:

CHECK
VISA
MASTERCARD
AMEX
DISCOVER
JCB
PRIVATE LABEL
GIFT CARD
DEBIT
EBT

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

Indicates the status of the authorization request.

This property contains the response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the to determine nature of a response message. A response code of "00" represents an approval. A response code of "10" indicates that the transaction was partially approved for a lesser amount (). 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.

commercialCardType
TSYSCommercialCardTypes (read-only)
Default Value: 0

Response property that indicates whether the card is a commercial card.

If you wish to support Corporate Purchasing Cards with Level II or Level III data, you should inspect the value of this property after a successful authorization. If the Vital/TSYS host indicates that the authorized card is a commercial card, you may use the TSYSLevel2 or TSYSLevel3 classs to add the extra data required during settlement.

Possible values for this property include:


tccNotCommercial (0)	Not a commercial card. You must not send Level II or Level III data in the settlement.
tccBusinessCard (1)	Business Card
tccVisaCommerce (2)	Visa Commerce (Reserved for future use)
tccCorporateCard (3)	Corporate Card
tccPurchaseCard (4)	Purchasing Card

Note: Of the possible s for Visa cards, you should only send Level III data for tctPurchaseCards. Level III may be sent for any MasterCard except cctNotCommercial.

This property is only valid after a successful authorization request and response.

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.

installmentAdvice
InstallmentAdvices (read-only)
Default Value: 0

Contains the Merchant Advice Code returned by MasterCard MIP.

Possible values are:


ivNoDataPresent (0)	Installment advice data was not returned.
ivNewAccountInfo (1)	New account information.
ivTryAgainLater (2)	Try again later.
ivDoNotTryAgain (3)	Do not try again for recurring payment transaction.
ivCancelRecurring (4)	Recurring payment cancellation.

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.

Constructors

public init()

Config Settings (TSYSHCECommerce 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.

TSYSHCECommerce Config Settings

AllowPartialAuths: Indicates whether partial authorizations are to be supported.

When this setting is True, if the credit card being authorized does not contain sufficient funds to cover the TransactionAmount, the card will not be declined. Instead, the transaction will be authorized for a lesser amount. The customer must then use another form of payment to make up the remainder. The total amount authorized by TSYS will be returned in the Response.AuthorizedAmount. For instance, if the TransactionAmount is $100.00, but the card only has a $50.00 balance, the card is charged for $50.00, and the Response.AuthorizedAmount will be "50.00". The merchant may then collect the remaining $50 in cash, check, credit card, or any other acceptable form of payment. This setting is False by default.

AlternateMerchantName: Contains an alternate merchant/DBA name.

This configuration setting allows you to specify an alternate merchant/DBA name. The specified value can be up to 25 characters (A/N and special chars) in length.

AuthorizationIndicator: The type of authorization request.

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

Valid values are:


Code	Description
P	Pre Authorization
F	Final Authorization
U	Undefined Authorization

CAVV: AuthenticationCAVV data from the ThreeDSecure class.

This setting is used to pass 3D Secure CAVV data on to the transaction server. This field must be formatted as a 28-byte Base-64 encoded value. This class may be used in conjunction with the ThreeDSecure class from the E-Payment Integrator toolkit or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include XID and ECI. This setting is only valid for E-Commerce transactions.

DigitalPaymentCryptogram: Digital Payment Cryptogram used for DSRP transactions (Mastercard only).

The Digital Payment Cryptogram is a 28 byte value and is used to send a Digital Secure Remote Payment (DSRP) cryptogram for DSRP transactions submitted as electronic commerce.

DirectoryServerTxnID: Directory Server Transaction ID generated by the EMV 3DS Mastercard Directory Server during authentication (Mastercard only).

The Directory Server Transaction ID is a 36 byte value generated by the EMV 3DS Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. This field allows the merchant to pass the Directory Server Transaction ID during authorization in order to link authentication and authorization data.

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=\" \"");

ISOIdentifier: ISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover.

This 11-digit value is assigned to the Service Provider designated as an ISO (Independent Sales Organization) during registration with the card brand and must be included on all MasterCard or Discover transactions where the merchant has a relationship with an ISO.

Language: Indicates the language to be used in formatting the authorization response text message.

This field allows you to specify the two-character indicator to indicate the format of the authorization response text message. The current possible values are:


00	English
01	Spanish
02	Portuguese

LocationDetailCity: Location Detail City.

This 13-character field is a subfield of Payment Facilitator.

For Visa and Mastercard transactions, enter the city of the sub-merchant location (not the Payment Facilitator location).

For Discover transactions, enter the location where the transaction took place; this may or may not be the sub-merchant location.

For Direct Marketing merchants and preferred customer/passenger transport and card not present transactions, this field must contain a phone number for merchant customer service in format XXX-XXXXXXX. The dash is required. This field can also be used for e-mail or a URL.

LocationDetailCountry: The Payment Facilitator Sub-Merchant Country Code.

This 3-digit field indicates the country of the Sub-Merchant location (not the Payment Facilitator location) using ISO-specified numeric codes. It is used for Visa, Mastercard, and Discover transactions and must be included on all transactions where the merchant has a relationship with a Payment Facilitator.

LocationDetailName: Location Detail Name.

This 25-character field has three usages. The Visa and Mastercard stipulations apply to any usage.

Usage 1 - Payment Facilitator Name*Sub-Merchant Name

This usage is valid for Visa, Mastercard, and Discover.

For Payment Facilitators, the field contains two parts in a concatenation of two fields separated by an asterisk (*). For Visa, Mastercard, and Discover the name submitted should match what the PayFac registered with each brand and should follow the requirements defined by each brand.

Usage 2 - Marketplace Name

For Visa Marketplaces, the field should contain the name of the Marketplace.

Usage 3 - Location Detail Name

This field is used to identify the merchant name that appears on the storefront and/or customer receipts and statements. It is commonly referred to as the DBA (Doing Business As) Name. If the name is more than 25 characters, use proper and meaningful abbreviation(s) when possible. Do not truncate.

LocationDetailPostalCode: The Payment Facilitator Sub-Merchant Postal Code.

This 9-character field indicates the postal code of the Sub-Merchant location (not the Payment Facilitator location). This field must be included on all transactions where the merchant has a relationship with a Payment Facilitator. It is used for Visa, Mastercard, and Discover transactions.

LocationDetailState: The Payment Facilitator Sub-Merchant State/Province Code.

This 2-character field indicates the state or province code of the Sub-Merchant location (not the Payment Facilitator location). If the Sub-Merchant is non-U.S. and non-Canadian, this field should be '00'. This field must be included on all Visa, Mastercard, and Discover transactions where the merchant has a relationship with a Payment Facilitator.

OriginalAmount: The Original Amount related to a previous Consumer Initiated Transaction (Discover only).

This configuration setting is required for Discover Merchant Initiated Transactions (MIT) with POSTransactionStatus: (P) Partial Shipment, (R) Recurring Payment, or (A) Re-authorize for Full Amount.

Note: When supporting MIT transactions for Discover cards, you must keep track of the Original Amount from the initial CIT transaction.

PFForeignRetailerIndicator: The Payment Facilitator Foreign Retailer Indicator (Visa only).

This 3-character field is used by marketplaces to uniquely identify domestic transactions in which the retailer is in a different country than the marketplace. Visa classifies an entity as a marketplace if it handles payments on behalf of retailers through an online marketplace that brings together multiple buyers and retailers. This field must be sent when the retailer is foreign.

Valid values are:


Code	Description
(Space) (default)	Space indicates the retailer is not foreign.
F	This value indicates the retailer is located in a different country than the marketplace.

Note: This field will be automatically left-justified, space-filled to 3 characters.

PFIdentifier: The Payment Facilitator/Marketplace Identifier.

Usage 1 - Payment Facilitator

This 11-digit value is assigned to the Service Provider during registration with Visa, Mastercard, or Discover.

Usage 2 - Visa Marketplaces

This 11-digit value is assigned to the Service Provider during registration with Visa as the Marketplace Identifier.

POSAcceptanceDeviceType: Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions.

This 1-character configuration setting is used to identify the type of device used by the merchant for accepting mobile Point of Sale (mPOS) transactions. Valid values are:


Value	Description
0	Dedicated mPOS Terminal with PCI compliant dongle (with or without key pad)
1	Off the Shelf Mobile Device
2	Dongle with software-based application that supports PIN entry on glass
3	Off the Shelf Mobile Device with software-based application that supports PIN entry on glass
M	Mobile POS Add-On Hardware
T	Tap on Mobile No Add-On Hardware

POSAuthEntity: The authentication entity to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B5 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Not authenticated
1	ICC - Offline PIN
2	Card acceptance device
3	Authorizing agent - Online PIN (MC)
4	Merchant/card acceptor - signature
5	Other (MC)
9	Unknown, data not available

POSCardCaptureCapability: Card capture capability data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B8 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	No capture capability
1	Card capture capability
9	Unknown; data not available

POSCardholderAuthCapability: Cardholder authentication capability data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B7 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	No electronic authentication capability
1	PIN capability
2	Electronic signature analysis capability (MC)
5	Electronic authentication capability is inoperative (MC)
6	Other (MC)
9	Unknown; data not available

POSCardholderAuthMethod: Cardholder authentication method to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B4 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Not authenticated
1	PIN
2	Electronic signature analysis (MC)
5	Manual signature verification
6	Other manual verification (driver's license number, etc)
9	Unknown, data not available
F	Suspected fraud (merchant suspicious)
Q	Cardholder verified by Biometrics
R	ID verified
S	Other systematic verification (MC)
T	Electronic ticket environment (Amex)

POSCardholderPresent: Cardholder present data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B1 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Cardholder present
1	Cardholder not present, unspecified reason
2	Cardholder not present, mail transaction
3	Cardholder not present, phone transaction
4	Cardholder not present, standing (recurring) transaction such as a subscription or Merchant Initiated Transaction (MIT)
5	Cardholder not present, electronic commerce
8	Cardholder not present, recurrent billing such as a loan or installment
R	Recurring purchase transaction (original transaction was token-based with valid cryptogram)
T	Click to Pay (Discover only)

POSCardInputCapability: Card input capability data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B6 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Unknown; data not available
1	Manual; no POS device
2	Magnetic stripe reader capability
3	Bar Code / Payment Code read
4	Optical Character Reader (OCR) capability (MC)
5	Integrated Circuit Card (ICC) capability
6	Key entry only capability
A	PAN auto-entry via contactless magnetic stripe
B	Magnetic stripe reader and key entry capability
C	Magnetic stripe reader, ICC and key entry capability
D	Magnetic stripe reader and ICC capability
E	ICC and key entry capability
H	ICC reader and contactless capability
M	PAN auto-entry via contactless chip
V	Other capability (MC)
X	Magnetic stripe signature (Amex)

POSCardInputMode: Card input mode to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B3 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Unspecified, data not available
1	Manual input, no POS device
2	Magnetic stripe reader input
3	Bar code/Payment code
6	Key entered input
7	Merchant initiates a transaction for the cardholder using the payment credential stored on file
A	PAN auto-entry via contactless magnetic stripe
B	Magnetic stripe reader input, track data captured and passed unaltered
C	Online chip
F	Offline chip
M	PAN auto-entry via contactless Chip (EMV Mode)
N	Track data read and sent unaltered, chip capable POS device, chip data could not be read
P	Track data read and sent unaltered, chip capable terminal not having an application that supports the chip card type.
R	PAN entry via electronic commerce, including remote chip
S	Electronic commerce, no security, channel encrypted, or SET without cardholder certificate
V	Manually entered with keyed CID (Amex, JCB Canada)
W	Swiped transaction with keyed CID (Amex, JCB Canada)
X	Magnetic stripe signature (Amex, JCB Canada)
Y	Magnetic stripe signature with keyed CID (Amex, JCB Canada)

POSCardOutputCapability: Card output capability data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B10 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Unknown; data not available
1	None
2	Magnetic strip write (MC)
3	ICC
S	Other (MC)

POSCardPresent: Card present data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B2 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Card not present
1	Card present
W	Transponder
X	Contactless chip
Z	Digital Wallet [AX]

POSChipConditionCode: Chip condition code to indicate the circumstances in which card data was entered at the POS.

This value is a one-character numeric code used in Visa Smart Debit/Visa Smart Credit (VSDC) transactions indicating whether VSDC terminals are functioning correctly when reading magnetic stripes in VSDC transactions. Specifically, this field provides data about magnetic stripe-read transactions at VSDC terminals that can be used to diagnose malfunctioning cards or terminals and to detect fraud patterns.This config maps to field A21_B13 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Default value when the service code does not begin with 2 or 6.
1	Use this value when service code begins with 2 or 6, and the last read from a chip at the chip capable terminal was successful, or was not a chip transaction, or unknown.
2	Use this value when the service code begins with 2 or 6, and last transaction at the chip capable terminal was an unsuccessful chip read.

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

POSEnvironmentIndicator: Provides additional information about the transaction.

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 POSCardInputMode 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 POSCardInputMode should be '7' for Credential on File transactions.

POSOperatingEnvironment: Operating environment data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B9 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	No POS device used
1	On card acceptor premises; attended POS device
2	On card acceptor premises; unattended POS device
3	Off card acceptor premises; attended
4	Off card acceptor premises; unattended
5	On cardholder premises; unattended
6	Off cardholder premises; unattended (MC)
9	Unknown; data not available
M	Off card acceptor premises; merchant mobile POS environment, including mPOS (Visa, MC)
P	On card acceptor premises; merchant mobile POS environment, including mPOS (Visa, MC)
Q	Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA (Visa, MC)
R	On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA (Visa, MC)
S	Electronic delivery of product (Amex)
T	Physical delivery of product (Amex)

POSPINCaptureCapability: PIN capture capability data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B12 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	No PIN capture capability
1	Unknown; data not available
2	Reserved
3	Reserved
4	PIN capture capability four characters maximum
5	PIN capture capability five characters maximum
6	PIN capture capability size characters maximum
7	PIN capture capability seven characters maximum
8	PIN capture capability eight characters maximum
9	PIN capture capability nine characters maximum
A	PIN capture capability ten characters maximum
B	PIN capture capability eleven characters maximum
C	PIN capture capability twelve characters maximum

POSTerminalOutputCapability: Terminal output capability data to indicate the circumstances in which card data was entered at the POS.

This config maps to field A21_B11 in the TSYS specification. Default values are sent based on specified data such as CardEntryDataSource but values may need to be set explicitly based on your POS operation and environment. Available values are:


Value	Description
0	Unknown; data not available
1	None
2	Printing capability only
3	Display capability only
4	Printing and display capability

POSTransactionStatus: A 1-character value used to indicate the purpose or status of the request.

Use this 1-character configuration setting to indicate the purpose or status of the request. Valid for Mastercard or Discover only.

The tables below provide the valid values for each card brand.

Valid values for Mastercard are:


Value	Description
0	Normal request (original presentment)
1	Deferred Authorizations
2	SecureCode Phone Order
3	ATM Installment Inquiry
4	Preauthorized request
5	Time Based Payment Authorization Request-Brazil domestic transactions
6	ATC Update
8	Account Status Inquiry Service (ASI)
9	Tokenization Request/Notification

Valid values for Discover are:


Value	Description
0	Normal request (original presentment)
4	Preauthorized request
A	Re-authorize for Full Amount
D	Delayed Card Sale
E	Resubmission of Card Sale
G	Transit Aggregated Transaction
I	Incremental Authorization
N	No-Show Charge
P	Partial Shipment
R	Recurring Payment
S	Merchant Installment Payment
T	Third Party Installment Payment
U	Unscheduled Payment
V	Issuer Installment Payment

Note: For Purchase Return Authorization Requests: Value must be 0 (Mastercard and Discover).

ProgramProtocol: Identifies the version of the EMV 3D-Secure protocol (Mastercard only).

The Program Protocol must be provided by the merchant if they are using the Mastercard Identity Check program to authenticate the cardholder. This value identifies the version of the EMV 3D-Secure protocol and it is the merchant's responsibility to know which version applies. Allowable values are:


Value	Description
1	EMV 3-D Secure Version 2.1
2	EMV 3-D Secure Version 2.2
3	EMV 3-D Secure Version 2.3
4	EMV 3-D Secure Version 2.4
5	EMV 3-D Secure Version 2.5
6	EMV 3-D Secure Version 2.6
7	EMV 3-D Secure Version 2.7
8	EMV 3-D Secure Version 2.8
9	EMV 3-D Secure Version 2.9

RawRequest: Returns the request sent to the server for debugging purposes.

After an operation this setting may be queried to return the request as it was sent to the server. This is useful for debugging purposes.

RawResponse: Returns the response received from the server for debugging purposes.

After an operation this setting may be queried to return the response as it was received from the server. This is useful for debugging purposes.

RequestToken: Indicates whether to request a token for the specified card data sent in an Authorize request.

When set to 'True' prior to sending a request (such as a Sale), a token will be requested for the specified Card data. Provided the authorization and token generation was successful, a token will be returned in the response and can be retrieved via Token. The returned token can then be used to process future transactions without the use of Card data with the exception of the expiration details. The default value is 'False'.

NOTE: When using this request, verification and authorization of the card will be performed.

ResponseCAVV: Used for 3D-Secure transactions. Indicates whether the submitted CAVV value passed validation.

This CAVV Result code indicates whether the authentication value submitted in the CAVV field can be validated by either Visa or the card issuer. The table below shows the possible values returned from Vital/TSYS.


Blank or not present	CAVV not validated.
0	CAVV not validated because erroneous data was submitted.
1	CAVV failed validation.
2	CAVV passed validation.
3	CAVV validation could not be performed; Issuer attempt incomplete.
4	CAVV validation could not be performed; Issuer system error.
5	Reserved for future use.
6	Reserved for future use.
7	CAVV attempt - failed validation - issuer available (US issued card/non-US acquirer).
8	CAVV attempt - passed validation - issuer available (US issued card/non-US acquirer).
9	CAVV attempt - failed validation - issuer unavailable (US issued card/non-US acquirer).
A	CAVV attempt - passed validation - issuer unavailable (US issued card/non-US acquirer).
B	CAVV passed validation, information only, no liability shift.
C	CAVV was not validated - attempted.
D	CAVV was not validated - authentication.

This field is read-only and is only returned for E-Commerce transactions where 3D-Secure data ( CAVV, ECI, and XID) was submitted in the authorization.

ResponseUCAF: Used for MasterCard SecureCode transactions to indicate whether MasterCard downgraded the SecureCode transaction and sent it to the Issuer.

This UCAF Result code indicates the security level and cardholder authentication associated with the transaction. Mastercard's processing rules allow merchants to gain a liability shift and interchange benefit if they submit their electronic commerce transactions for cardholder authentication. If the cardholder authentication detail is not present in UCAFData field for MasterCard SecureCode transactions, MasterCard will downgrade and send the transaction to the Issuer. This field is read-only and is only returned for MasterCard SecureCode E-Commerce transactions to indicate if the transaction was downgraded or not.

RetrieveToken: Sends a Token Only request.

This is an action config which when called will send a token only request to the TSYS Host. Provided the request was successful, a token will be returned for the specified Card. The token can be retrieved via Token. For this request, no card verification or authorization will be performed.

ServerURL: 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 "https://ssl2.vitalps.net/scripts/gateway.dll?transact", but you may use "https://ssltest.tsysacquiring.net/scripts/gateway.dll?transact" for testing.

SubMerchantIdentifier: The Payment Facilitator Sub-Merchant Identifier.

This 15-character field, assigned by the Payment Facilitator or the Acquirer, must be provided on all Visa, Mastercard, or Discover transactions where the merchant has a relationship with a Payment Facilitator.

SurchargeAmount: The transaction fee amount charged to the customer to account for acquirer-assessed surcharge.

This configuration setting is for informational purposes only and any surcharge amounts charged to the customer should be included in the TransactionAmount.

The format of this field is 'annnnnnnn' where 'a' is either 'D' for debit or 'C' for credit. 'nnnnnnnn' is the numeric fee amount with the decimal implied. For example: 'D00000150' is a $1.50 transaction fee amount debited to the cardholder's account.

Note: If an amount is only specified, the component will generate the format above by prepending a 'D' and the necessary number of 0's.

Token: The token received from the TSYS host when a token request is sent.

This field will contain the token received from TSYS from either a RetrieveToken or RequestToken request. This field is also used to specify a token value, used in place of Card data, to be sent in an authorization request (such as Sale or Credit).The token is formatted as a card number, with the last 4 digits preserved. Other characters in the number will be letters rather than numbers. Tokens are used as an added security measure to protect a customer's Card and may also help decrease PCI Compliance verification as storing credit card data is no longer needed.

UCAFCollectionIndicator: Indicates the merchant's support and usage of UCAF in MasterCard SecureCode transactions.

This configuration setting is used to pass the UCAF Collection Indicator on MasterCard SecureCode e-commerce credit transactions. Mastercard's processing rules allow merchants to gain a liability shift and interchange benefit if they submit their electronic commerce transactions for cardholder authentication. Merchants need to pass the appropriate authentication detail in UCAFData. Other values necessary for passing SecureCode data include UCAFData and ECI. This setting is required on all MasterCard SecureCode E-Commerce transactions. The valid values for this configuration setting are:


Indicator	Description
0	UCAF data is not supported by the merchant or the merchant has chosen not to send the indicator.
1	UCAF data collection is supported by the merchant and UCAF data was present and contained an attempted AAV for Mastercard SecureCode.
2	UCAF data collection is supported by the merchant and UCAF data was present and contained a fully authenticated AAV.
5	Issuer Risk-Based Decisioning.
6	Merchant Risk-Based Decisioning.
7	Partial Shipment, Incremental or Recurring Payment.

UCAFData: UCAF Authentication data from the MasterCard SecureCode authentication.

This configuration setting is used to pass encoded MasterCard SecureCode issuer or cardholder-generated authentication data. This is a variable length security field up to 32 bytes in length. This setting is only valid for MasterCard E-Commerce transactions.

UCAFSecurityIndicator: Indicates the security level and cardholder authentication in MasterCard SecureCode transactions.

This configuration setting is used to pass the UCAF electronic commerce indicators representing the security level and cardholder authentication associated with the transaction. Mastercard's processing rules allow merchants to gain a liability shift and interchange benefit if they submit their electronic commerce transactions for cardholder authentication. Merchants need to pass the appropriate authentication detail in UCAFData. Other values necessary for passing SecureCode data include UCAFIndicator, UCAFData and ECI. This setting is recommended in all MasterCard SecureCode E-Commerce transactions. The valid values for this configuration setting are:


Security Protocol/Cardholder Authentication	Description
21	Channel encryption; cardholder certificate not used(preferred value for Mastercard SecureCode).
22	Masterpass-generated transaction.
24	Digital Secure Remote Payment (DSRP) with UCAF Data.

XID: TransactionId from a 3D Secure authentication.

This setting is used to pass the 3D Secure TransactionId (XID) data on to the credit card processor. This setting must be formatted as a 20-byte plaintext value, or a 28-byte Base-64 encoded value. This class may be used in conjunction with the ThreeDSecure class from the E-Payment Integrator toolkit or with any other 3D Secure MPI implementation. For example: Other settings necessary for passing 3D Secure data are CAVV and ECI. This setting is only valid for E-Commerce transactions.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class .

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If , the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If , the connection will be closed immediately after the server response is received.

The default value for KeepAlive is .

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.