TSYSHCReversal Module

Properties Methods Events Config Settings Errors

The TSYSHCReversal module is used to reverse a previously authorized transaction. This module makes reversing transactions very easy.

Syntax

DPaymentsSDK.Tsyshcreversal

Remarks

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

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

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

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

Next, set properties that contain details about the transaction. At a minimum, you must set a RetrievalNumber, TransactionAmount, and TransactionType.

TSYSHCReversal1.TransactionType = ttCreditAuthorizationReversal TSYSHCReversal1.TransactionAmount = TSYSHCRetail1.TransactionAmount TSYSHCReversal1.RetrievalNumber = TSYSHCRetail1.Response.RetrievalNumber TSYSHCReversal1.CardType = TSYSHCRetail1.Response.CardType;

Finally, submit the transaction reversal request by calling Reverse. TSYSHCReversal1.Reverse()

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the reversal was approved. The remaining properties provide additional information about the transaction.

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

Property List

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


CardType	Type of the credit card.
CashBackAmount	Amount returned to the customer in cash.
GenKey	The unique GenKey value used to identify a POS device.
MerchantId	The unique ID that associates the POS device with the merchant account.
RepeatIndicator	Indicates whether a transaction is a repeat of a previous transaction attempt.
Response	Contains the response to an adjustment request.
RetrievalNumber	The retrieval reference number (RRN) used to identify a transaction.
RoutingId	The Routing ID assigned to the merchant by TSYS.
SettleAmount	The final settlement amount.
SSLAcceptServerCertEncoded	This is the certificate (PEM/Base64 encoded).
SSLCertEncoded	This is the certificate (PEM/Base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/Base64 encoded).
Timeout	A timeout for the module.
TransactionAmount	Purchase amount to be authorized.
TransactionDesc	Soft (Dynamic) Descriptor.
TransactionNumber	Sequence number of this transaction.
TransactionType	Specifies the original transaction type that you wish to reverse.

Method List

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


Config	Sets or retrieves a configuration setting.
Interrupt	Interrupts the current action.
Reset	Clears all properties to their default values.
Reverse	Performs a reversal transaction.

Event List

The following is the full list of the events fired by the 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.
AuthorizationIndicator	The type of authorization request.
ECI	Electronic Commerce Indicator.
IsBillPayment	Indicates that the transaction being reversed is a bill payment transaction.
Language	Indicates the language to be used in formatting the authorization response text message.
MessageReasonCode	The reversal message reason code used to identify why the reversal is being made.
POSAcceptanceDeviceType	Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions.
POSAuthEntity	The authentication entity to indicate the circumstances in which card data was entered at the POS.
POSCardCaptureCapability	Card capture capability data to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthCapability	Cardholder authentication capability data to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthMethod	Cardholder authentication method to indicate the circumstances in which card data was entered at the POS.
POSCardholderPresent	Cardholder present data to indicate the circumstances in which card data was entered at the POS.
POSCardInputCapability	Card input capability data to indicate the circumstances in which card data was entered at the POS.
POSCardInputMode	Card input mode to indicate the circumstances in which card data was entered at the POS.
POSCardOutputCapability	Card output capability data to indicate the circumstances in which card data was entered at the POS.
POSCardPresent	Card present data to indicate the circumstances in which card data was entered at the POS.
POSChipConditionCode	Chip condition code to indicate the circumstances in which card data was entered at the POS.
POSCITMITIndicator	CIT/MIT Indicator.
POSOperatingEnvironment	Operating environment data to indicate the circumstances in which card data was entered at the POS.
POSPINCaptureCapability	PIN capture capability data to indicate the circumstances in which card data was entered at the POS.
POSTerminalOutputCapability	Terminal output capability data to indicate the circumstances in which card data was entered at the POS.
POSTransactionStatus	A 1-character value used to indicate the purpose or status of the request.
RawRequest	Returns the request sent to the server for debugging purposes.
RawResponse	Returns the response received from the server for debugging purposes.
ServerURL	The server to which transactions are posted.
SurchargeAmount	The transaction fee amount charged to the customer to account for acquirer-assessed surcharge.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the 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.

CardType Property (TSYSHCReversal Module)

Type of the credit card.

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


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

- (NSString*)cardType;
- (void)setCardType :(NSString*)newCardType;

Default Value

Remarks

TSYS determines the type of credit card used for each authorization, and returns that value to the merchant in the response. The following example shows how to set CardType property from the response of the TSYSHCRetail component: TSYSHCReversal1.CardType = TSYSHCRetail1.Response.RetrievalNumber;

Possible values are:

VISA
MASTERCARD
AMEX
DISCOVER
JCB
PRIVATE LABEL
GIFT CARD
DEBIT
EBT

CashBackAmount Property (TSYSHCReversal Module)

Amount returned to the customer in cash.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=cashBackAmount,setter=setCashBackAmount:) NSString* cashBackAmount;

- (NSString*)cashBackAmount;
- (void)setCashBackAmount :(NSString*)newCashBackAmount;

Default Value

Remarks

This property may contain an optional cash back amount when authorizing a Debit Purchase transaction, EBT Cash Benefit Purchase, or a Gift Card Purchase transaction. The value of TransactionAmount must reflect the cost of the goods or service purchased plus this CashBackAmount.

Note: CashBackAmount must be empty for Restaurant IndustryType as this is not supported by TSYS.

Note: TSYS does not support transactions containing both CashBack and Gratuity/Tip amounts.

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

Note: For EBT Withdrawal transactions, CashBackAmount must be empty. However, when creating detail records for the settlement of the transaction, the DebitCashBack in the detail record must match the TransactionAmount for the authorization.

GenKey Property (TSYSHCReversal 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.

MerchantId Property (TSYSHCReversal 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 (TSYSHCReversal 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 (TSYSHCReversal Module)

Contains the response to an adjustment request.

Syntax

Swift
Objective-C

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


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

- (int)responseBatchNumber;

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

- (NSString*)responseCode;

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

- (NSString*)responseRetrievalNumber;

@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=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 adjustment to determine if the transaction was approved. The TSYSHCAdjustmentResponse type contains the following fields:


	Contains the incrementing ID assigned by TSYS to identify a merchant batch.
	This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
	Local transaction date returned from the server in MMDDYY format.
	Local transaction time returned from the server in HHMMSS format.
	Check this field against the original Transaction Number.
	Indicates the status of the authorization request.
	Text information that describes each response code.

RetrievalNumber Property (TSYSHCReversal Module)

The retrieval reference number (RRN) used to identify a transaction.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=retrievalNumber,setter=setRetrievalNumber:) NSString* retrievalNumber;

- (NSString*)retrievalNumber;
- (void)setRetrievalNumber :(NSString*)newRetrievalNumber;

Default Value

Remarks

This property is used to specify the retrieval reference number (RRN) for the transaction that you wish to retrieve or adjust. This value is used by the Host Capture system to identify the transaction.

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

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

RoutingId Property (TSYSHCReversal 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.

SettleAmount Property (TSYSHCReversal Module)

The final settlement amount.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=settleAmount,setter=setSettleAmount:) NSString* settleAmount;

- (NSString*)settleAmount;
- (void)setSettleAmount :(NSString*)newSettleAmount;

Default Value

Remarks

This property is used when running a Partial Reversal transaction to specify the final settlement (transaction) amount. The final settlement amount can only be decreased. Thus SettleAmount must be less than TransactionAmount. If you wish to perform a Full Reversal you should not set SettleAmount.

Note: Partial Reversals are not supported by Amex.

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

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

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

public enum TsyshcreversalSSLCertStoreTypes: 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 (TSYSHCReversal 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 (TSYSHCReversal Module)

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

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

public enum TsyshcreversalSSLProviders: 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 (TSYSHCReversal 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 (TSYSHCReversal 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 (TSYSHCReversal 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 (TSYSHCReversal 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 (TSYSHCReversal 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 (TSYSHCReversal Module)

Specifies the original transaction type that you wish to reverse.

Syntax

Swift
Objective-C

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

public enum TsyshcreversalTransactionTypes: Int32 {
  case ttCreditAuthorizationReversal = 0
  case ttDebitAuthorizationReversal = 1
  case ttDebitCreditReversal = 2
  case ttGiftCardAuthorizationReversal = 3
  case ttFoodStampAuthorizationReversal = 4
  case ttCashBenefitAuthorizationReversal = 5
  case ttFoodStampCreditReversal = 6
  case ttCashBenefitCreditReversal = 7
}


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

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

Default Value

Remarks

This property indicates the original transaction type that you want to reverse. The following table explains the transaction types in detail:


ttCreditAuthorizationReversal (0)	This transaction reverses a previous credit card purchase transaction (also known as Online Authorization Reversal). This type should be used when reversing a TSYSHCRetail or TSYSHCECommerce authorization transaction.
ttDebitAuthorizationReversal (1)	This transaction reverses a previous debit card purchase transaction. This type should be used when reversing a TSYSHCDebit authorization transaction.
ttDebitCreditReversal (2)	This transaction reverses a previous debit card refund transaction. This type should be used when reversing a TSYSHCDebit credit transaction.
ttGiftCardAuthorizationReversal (3)	This transaction reverses a previous gift card purchase transaction. This type should be used when reversing a TSYSHCGIFTCARD authorization transaction.
ttFoodStampAuthorizationReversal (4)	This transaction reverses a previous EBT card Food Stamp purchase transaction. This type should be used when reversing a TSYSHCBenefit authorization transaction.
ttCashBenefitAuthorizationReversal (5)	This transaction reverses a previous EBT card Cash Benefit purchase transaction. This type should be used when reversing a TSYSHCBenefit authorization transaction.
ttFoodStampCreditReversal (2)	This transaction reverses a previous EBT card Food Stamp refund transaction. This type should be used when reversing a TSYSHCBenefit credit transaction.
ttCashBenefitCreditReversal (2)	This transaction reverses a previous EBT card Cash Benefit refund transaction. This type should be used when reversing a TSYSHCBenefit credit transaction.

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

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

Reverse Method (TSYSHCReversal Module)

Performs a reversal transaction.

Syntax

Swift
Objective-C

public func reverse() throws -> Void

- (void)reverse;

Remarks

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

Minimum required properties:

GenKey
CardType (required for Visa, Mastercard, Amex, or Discover transactions)
MerchantId
RoutingId
RetrievalNumber
TransactionAmount
TransactionType

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

TSYSHCAdjustmentResponse Type

Contains the response to the adjustment.

Remarks

This type contains the results of an adjustment transaction made with the TSYSHCAdjustment, TSYSHCLevel3, or TSYSHCReversal class. The properties contained by this type are listed below.

Fields

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.

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.

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.

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.

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

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

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

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

IsBillPayment: Indicates that the transaction being reversed is a bill payment transaction.

This field, when set to 'True', indicates that the transaction is a Bill Payment transaction and will be processed as such. When set to 'False' (default value) the transaction will be processed normally.

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

MessageReasonCode: The reversal message reason code used to identify why the reversal is being made.

This config is required when a reversal is being made. Applicable values are:

Reversals


Code	Definition
2501	Transaction voided by customer
2502	Transaction has not completed (Request timed out or POS device malfunctioned)
2503	No confirmation from the point of sale
2504	POS partial reversal
2516	Premature chip card removal (after online request sent before response received)
2517	Chip declined transaction after online issuer approved

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.

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

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.

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.

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.

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.