TSYSBenefit Configuration

When this setting is True, if the 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 ResponseAuthorizedAmount configuration setting. 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 ResponseAuthorizedAmount 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.

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.

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

Valid values are:

If an authorization returns ambiguously or times out without receiving a response, you may send the same transaction over again with this Retry flag set to True. This will prevent you from double-charging your customers in the case of a communications error (only available for credit card transactions. Does not apply to Debit, Gift Card, or EBT transactions).

When set to 'True', AVS data will be sent in the extended AVS field for the transaction. ResponseCardholderVerification will contain the extended AVS verification results. When set to 'False' (default value), the CustomerAddress and CustomerZip values will be sent using the simple AVS data fields.

The value of this field is used to correctly match responses with transactions by comparing its value to that of the MerchantStoreNumber. This is particularly useful when making a multi-merchant or multi-store routing system. If the system that originally made the transaction receives a response where the ResponseStoreNumber is not identical to the MerchantStoreNumber the transaction should not be stored for batch settlement. This field is read-only.

The value of this field is used to correctly match responses with transactions by comparing its value to that of MerchantTerminalNumber. This is particularly useful when making a multi-terminal routing system within a merchant location. If the terminal that originally made the transaction receives a response where the ResponseTerminalNumber is not identical to the MerchantTerminalNumber, the transaction should not be stored for batch settlement. This field is read-only.

This response data is returned when SendExtendedAVS is set to 'True' and is only available for American Express and Discover cards. This data is arranged in order of 5 bytes, one for each result of a cardholder identification data element:

The possible values for each byte are:

For Discover transactions, byte 3 will be populated with the following values:

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

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

This field is used to specify the AuthenticationCode, assigned by TSYS, to authenticate a POS device (made via a call to ActivateTerminal).

This is an action config which when called will authenticate a POS device with TSYS. Authentication is required when processing transactions using Voltage Encryption or Tokenization. An AuthenticationCode is required to be specified, as is MerchantZip and/or MerchantServicePhone, to perform authentication. After a POS device is successfully authenticated, GenKey will be populated.

This is an action config which when called will deactivate the POS device specified via GenKey with TSYS.

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

This field is used to specify the Base-64 encoded ETB (Encryption Transmission Block) used by TSYS to decrypt Voltage encrypted data. The value is retrieved from the POS device containing the Voltage encryption software. When specified, the transaction will be sent as a Voltage encrypted transaction. The encrypted card data will be specified as normal via the CardMagneticStripe or CardNumber fields.

When set to "True", a confirmation authorization transaction will be sent. In a confirmation request, TSYS will generate the Retrieval Reference Number (ResponseRetrievalNumber) and the System Trace Audit Number (ResponseTrace). When setting this property to "False" (default value), a NonConfirm authorization transaction will be sent. In these transactions, a Retrieval Reference Number, System Trace Audit Number, Local Date, and Local Time are NOT generated by TSYS and must be manually specified by the POS application. By default, the component will automatically generate these values for you. However you can override them by setting the following properties: LocalRetrievalNumber, LocalDate, , and LocalTime. Note the System Trace Audit Number is required to be the last 6 characters of the LocalRetrievalNumber and thus the component will automatically obtain and send this value for you.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

This property is used to specify the Retrieval Reference Number to use in a NonConfirm authorization request (when UseConfirmationRequest = "False"). The specified value must contain a 12-character numeric value. It is suggested that the first 4 characters be the Julian date (yddd) and the remaining 8 characters are a numeric transaction identification number. If this value is set to "" (empty string), the component will generate a Retrieval Reference Number for you when the authorization request is sent.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

This property is used to specify the local transaction date to use in a NonConfirm authorization request (when UseConfirmationRequest = "False"). The specified value must be in MMDDYY format. If "" (empty string) is specified, the component will generate the local transaction date for you based on the current system time.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

This property is used to specify the local transaction time to use in a NonConfirm authorization request (when UseConfirmationRequest = "False"). The specified value must be in HHMMSS format. If "" (empty string) is specified, the component will generate the local transaction time for you based on the current system time.

Note: This setting is only valid for Debit and EBT/Benefit transactions.

This field allows you to specify the processor that you are connecting to (thus allowing the control to correctly generate the request and parse the response). The available values are:

Note that when set, this property will set the Server and Port to the default values for the specified processor. Additionally, this config must be set prior to setting Card to ensure the card data is formatted correctly.

This field allows you to specify the Heartland E3 encryption mode used when processing Heartland transactions. The available values are (descriptions describe the data that will be encrypted):

Note you will also need to set Processor to 1 (Heartland) and HeartlandKeyBlock if you wish to process Heartland E3 transactions.

The specified value must be 4 characters or less. Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.

This field allows you to specify the key block that was used to encrypt the data specified by HeartlandEncryptionMode. This value will be obtained from an E3 magnetic stripe reader and is used by Heartland to decrypt the encrypted data.

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

The default value for Timeout is 30 (seconds).

The default code page is the Active Code Page (0).

The following is a list of valid code page identifiers:

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