TSYSDebit Component
Properties Methods Events Config Settings Errors
The TSYSDebit component is an advanced tool used to authorize debit cards in a Retail environment, where the customer is purchasing products or services in person. This component makes authorizing debit card transactions with a customer PIN very easy. Supported Industry Types include retail stores, restaurants, and grocery stores.
Syntax
DPayments.DPaymentsSDK.Tsysdebit
Remarks
This component allows for simple, direct, secure connection to the Vital/TSYS SSL gateway through a standard Internet connection. Because all SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated SSL servers.
The TSYSDebit component makes authorizing debit card transactions (where the customer's card is swiped through a card reader and a PIN is supplied) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, SSL handshakes, or data packet formatting. The steps to setting up the component and authorizing a transaction are outlined below:
First, set the merchant properties with setup information acquired from your member bank or processor. For instance:
TSYSDebit1.Reset
TSYSDebit1.MerchantBankId = "999995" '(BIN Number)
TSYSDebit1.MerchantNumber = "888000002447"
TSYSDebit1.MerchantName = "TEST MERCHANT"
TSYSDebit1.MerchantTerminalNumber = "1515"
TSYSDebit1.MerchantStoreNumber = "5999"
TSYSDebit1.MerchantCategoryCode = "5999"
TSYSDebit1.MerchantCity = "Durham"
TSYSDebit1.MerchantState = "NC"
TSYSDebit1.MerchantZip = "27713"
TSYSDebit1.MerchantTimeZone = "705"
TSYSDebit1.MerchantABANumber = "123456789"
TSYSDebit1.MerchantSettlementAgent = "V123"
TSYSDebit1.AgentBankNumber = "000000"
TSYSDebit1.AgentChainNumber = "111111"
TSYSDebit1.ReimbursementAttribute = raStandardRetail
TSYSDebit1.SharingGroup = "GWQEV5"
TSYSDebit1.IndustryType = itRetail
Next, set properties that contain details about the transaction. The TransactionNumber is a sequence number, and should be incremented for each transaction you send. BatchNumber indicates which batch you will settle this authorization in. It should match the BatchNumber you set in the TSYSSettle component when you settle this transaction. TransactionAmount is the amount of sale, plus any CashBackAmount returned to the customer, formatted with an implicit decimal place. The CardTrack2Data is read from the magnetic stripe on the back of the card, and the DebitPIN and DebitKSN are retrieved from a standard DUKPT Pin Pad device.
TSYSDebit1.TransactionNumber = 1
TSYSDebit1.BatchNumber = 213
TSYSDebit1.TransactionAmount = "1000"
TSYSDebit1.CashBackAmount = "300"
TSYSDebit1.CardTrack2Data = "9999999800002773=09121015432112345678"
TSYSDebit1.CardPIN = "83C33384650827F6"
TSYSDebit1.CardKSN = "4A00310459400004"
Finally, submit the transaction by calling one of three authorization methods. Sale, Credit or BalanceInquiry. The following code demonstrates a purchase:
TSYSDebit1.Sale()
If wish refund money to a customer's debit card, you must also supply an OriginalPurchaseDate before calling Credit.
When the component receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The Code indicates whether the transaction was approved, and the remaining properties provide additional information about the transaction.
Once a debit card Sale or Credit is approved, 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 by passing the XML aggregate returned from the GetDetailAggregate method to the TSYSSettle component. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day. Note that BalanceInquiry transactions can not be settled.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AgentBankNumber | Identifies a specific agent entity of the member bank or processor. |
AgentChainNumber | Identifies a specific chain of an agent organization. |
BatchNumber | The batch number that this transaction will be included in. |
CardTrack2Data | Track 2 data for a debit transaction |
CashBackAmount | Amount returned to the customer in cash. |
DebitKSN | Clear-text Key Sequence Number, used for Debit and EBT transactions. |
DebitPIN | DUKPT DES encrypted PIN block, used for Debit and EBT transactions. |
IndustryType | Code which indicates the industry the merchant is engaged in. |
Merchant | Contains the merchant's setup information. |
MerchantABANumber | Merchant's routing number. |
MerchantSettlementAgent | Merchant's settling agent. |
OriginalPurchaseDate | Date and time of original purchase, used for returns. |
ReimbursementAttribute | Indicates the type of fee applicable to this transaction. |
Response | Contains the response to a debit authorization request. |
SharingGroup | List of Debit and EBT networks that the merchant supports. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | A timeout for the component. |
TransactionAmount | Purchase amount to be authorized. |
TransactionNumber | Sequence number of this transaction. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
BalanceInquiry | Retrieves the current available balance of the debit card. |
Config | Sets or retrieves a configuration setting. |
Credit | Credits a debit card (with a customer-entered PIN). |
GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
Interrupt | Interrupts the current action. |
Reset | Clears all properties to their default values. |
Sale | Authorizes a Debit card (with a customer-entered PIN). |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Connected | Fired immediately after a connection completes (or fails). |
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
Disconnected | Fired when a connection is closed. |
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
ActivateTerminal | Authenticates a POS device with TSYS. |
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
AuthenticationCode | An alphanumeric code provided to the POS user for input when authenticating a POS device. |
AuthorizationIndicator | The type of authorization request. |
CardholderId | Specifies the method used to verify the identity of the cardholder. |
ChipConditionCode | The condition code of magnetic stripe read transactions of EMV (chip capable) cards. |
DeactivateTerminal | Deactivates a POS device with TSYS. |
EMVData | The EMV Data returned from a Pin Pad after reading an EMV card. |
GatewayID | A unique value to identify a Gateway or Aggregator. |
GenKey | A randomly generated string of alphanumeric characters identifying the terminal. |
HeartlandDeviceId | Specifies a device ID to uniquely identify each terminal (card data entry device). |
HeartlandEncryptionMode | Specifies the encryption mode to use in Heartland transactions. |
HeartlandKeyBlock | Specifies the key block used to encrypt the data. |
ISOIdentifier | ISO (Independent Sales Organization) Identifier assigned by MasterCard or Discover. |
LocalRetrievalNumber | Specifies the Retrieval Reference Number to use in a NonConfirm authorization request. |
LocalTransactionDate | Specifies the local transaction date to use in a NonConfirm authorization request. |
LocalTransactionTime | Specifies the local transaction time to use in a NonConfirm authorization request. |
LocationDetailAddress | Merchant's street address. |
LocationDetailCity | Name of the city. |
LocationDetailCountry | Country code. |
LocationDetailEmail | Merchant's e-mail adress. |
LocationDetailName | Merchant name. |
LocationDetailPhone | Merchant's phone number. |
LocationDetailPostal | Postal code. |
LocationDetailRegion | Region code that corresponds to the state, province, or other country subdivision. |
MerchantSellerID | Merchant's Seller ID. |
MessageReasonCode | Code used to identify Deferred Authorizations for Visa. |
MobileDeviceType | Identifies the type of mobile device used by the cardholder to initiate the transaction. |
MPGID | Merchant Payment Gateway ID. |
PFAcquirerInternalReferenceNumber | Acquirer Internal Reference Number (AIRN) (Discover only). |
PFForeignRetailerIndicator | The Payment Facilitator Foreign Retailer Indicator (Visa only). |
PFIdentifier | The Payment Facilitator/Marketplace Identifier assigned by Visa, MasterCard, or Discover. |
PFNameSubMerchantName | The Payment Facilitator Name*Sub-Merchant name. |
PFSubMerchantCity | The Payment Facilitator Sub-Merchant City. |
PFSubMerchantCountry | The Payment Facilitator Sub-Merchant Country Code. |
PFSubMerchantIdentifier | The Payment Facilitator Sub-Merchant Identifier. |
PFSubMerchantPostalCode | The Payment Facilitator Sub-Merchant Postal Code. |
PFSubMerchantState | The Payment Facilitator Sub-Merchant State/Province Code. |
Port | The port to which transactions are posted. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
Processor | Specifies the Processor you are connecting to. |
ResponseCardholderVerification | Verification results for cardholder identification data (extended AVS). |
ResponseEMVData | The EMV Data returned in an authorization response. |
ResponseStoreNumber | Check this field against the original Merchant StoreNumber. |
ResponseTerminalNumber | Check this field against the original Merchant TerminalNumber. |
Retry | Set this to retry a failed transaction. |
SendExtendedAVS | Specifies whether to send extended AVS data. |
Server | The server to which transactions are posted. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
TLID | Transaction Link Identifier. |
TsysETB | The Encryption Transmission Block TSYS uses to decrypt encrypted data. |
UseConfirmationRequest | Indicates whether or not to send a Confirmation Request authorization transaction. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AgentBankNumber Property (TSYSDebit Component)
Identifies a specific agent entity of the member bank or processor.
Syntax
Default Value
"000000"
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purposes of identifying a specific agent entity of the member bank or processor.
AgentChainNumber Property (TSYSDebit Component)
Identifies a specific chain of an agent organization.
Syntax
Default Value
"000000"
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purpose of identifying a specific chain of an agent organization.
BatchNumber Property (TSYSDebit Component)
The batch number that this transaction will be included in.
Syntax
Default Value
1
Remarks
Unlike regular credit card transactions, Debit, EBT, and GiftCard transactions require that the Batch Number be sent in the authorization request. This number should be the same number you set to the TSYSSettle component's BatchNumber property. The range is from 1 to 999.
CardTrack2Data Property (TSYSDebit Component)
Track 2 data for a debit transaction
Syntax
Default Value
""
Remarks
This is a variable length field with a maximum data length of 37 characters. For Retail Card Present transactions, this property will contain the entire UNALTERED track as read from a credit card's magnetic stripe. This includes all framing characters. However, the track should be converted to 8-bit ASCII before this property is set (most card readers do this automatically).
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.
CashBackAmount Property (TSYSDebit Component)
Amount returned to the customer in cash.
Syntax
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.
DebitKSN Property (TSYSDebit Component)
Clear-text Key Sequence Number, used for Debit and EBT transactions.
Syntax
Default Value
""
Remarks
The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. The maximum length is 16 characters.
DebitPIN Property (TSYSDebit Component)
DUKPT DES encrypted PIN block, used for Debit and EBT transactions.
Syntax
Default Value
""
Remarks
The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. The maximum length is 16 characters.
IndustryType Property (TSYSDebit Component)
Code which indicates the industry the merchant is engaged in.
Syntax
public TsysdebitIndustryTypes IndustryType { get; set; }
enum TsysdebitIndustryTypes { sitUnknown, sitRetail, sitRestaurant, sitGroceryStore, sitDirectMarketing, sitHotel, sitAutoRental, sitPassengerTransport }
Public Property IndustryType As TsysdebitIndustryTypes
Enum TsysdebitIndustryTypes sitUnknown sitRetail sitRestaurant sitGroceryStore sitDirectMarketing sitHotel sitAutoRental sitPassengerTransport End Enum
Default Value
1
Remarks
This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this component.
sitUnknown (0) | Unknown or unsure. |
sitRetail (1) | Retail store. |
sitRestaurant (2) | Food / Restaurant. |
sitGroceryStore (3) | Grocery store or supermarket. |
sitDirectMarketing (4) | eCommerce or Direct Marketing |
sitHotel (5) | Hotel / Lodging |
sitAutoRental (6) | Auto Rental |
sitPassengerTransport (7) | Passenger Transport |
Note: American Express cards are NOT currently supported in the sitAutoRental industry.
Note: itDirectMarketing, itHotel, and itAutoRental are NOT supported for this component All Debit, EBT, and Gift Card transactions must be face-to-face card present transactions.
Merchant Property (TSYSDebit Component)
Contains the merchant's setup information.
Syntax
public TSYSMerchant Merchant { get; set; }
Public Property Merchant As TSYSMerchant
Remarks
This property must be set to an instance of the TSYSMerchant type, which will contain information to identify the merchant to the TSYS processing server. Please see the TSYSMerchant type for a list of available fields.
Please refer to the TSYSMerchant type for a complete list of fields.MerchantABANumber Property (TSYSDebit Component)
Merchant's routing number.
Syntax
Default Value
""
Remarks
This property identifies the merchant to a direct debit switch, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 9 digits in length.
MerchantSettlementAgent Property (TSYSDebit Component)
Merchant's settling agent.
Syntax
public string MerchantSettlementAgent { get; set; }
Public Property MerchantSettlementAgent As String
Default Value
""
Remarks
This property identifies the merchant settling agent, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 4 digits in length.
OriginalPurchaseDate Property (TSYSDebit Component)
Date and time of original purchase, used for returns.
Syntax
Default Value
""
Remarks
This property is only applicable for Debit Credit transactions and Gift Card Refund transactions. If supplied, this property must be 8 characters long and formatted as "MMDDhhmm" (month, day, hour, minute).
ReimbursementAttribute Property (TSYSDebit Component)
Indicates the type of fee applicable to this transaction.
Syntax
public TsysdebitReimbursementAttributes ReimbursementAttribute { get; set; }
enum TsysdebitReimbursementAttributes { raStandardRetail, raQualifiedGrocery, raPreExistingRetail, raPreExistingGrocery, raNonDebit, raTaxExempt }
Public Property ReimbursementAttribute As TsysdebitReimbursementAttributes
Enum TsysdebitReimbursementAttributes raStandardRetail raQualifiedGrocery raPreExistingRetail raPreExistingGrocery raNonDebit raTaxExempt End Enum
Default Value
0
Remarks
This property contains the reimbursement attribute assigned by the signing member or processor. This property designates the Reimbursement Fee applicable to a transaction. The following values are valid for Debit and EBT:
raStandardRetail (0) | Standard INTERLINK Retail Merchant. |
raQualifiedGrocery (1) | Qualified INTERLINK Supermarket/Grocery Merchant. |
raPreExistingRetail (2) | Pre-existing Qualified INTERLINK Retail Merchant. |
raPreExistingGrocery (3) | Pre-existing Qualified INTERLINK Supermarket/Grocery Merchant. |
raNonDebit (4) | EBT, non-debit, or Non-INTERLINK debit. |
raTaxExempt (5) | Tax exempt organizations. |
Response Property (TSYSDebit Component)
Contains the response to a debit authorization request.
Syntax
public TSYSDebitResponse Response { get; }
Public ReadOnly Property Response As TSYSDebitResponse
Remarks
This property will contain the response returned from the TSYS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The TSYSResponse type contains the following fields:
ApprovalCode | Contains an authorization code for approved transactions, or a description of the error for declines. |
AuthorizedAmount | Amount actually used from the card (used when supporting partial redemptions). |
AuthSource | Indicates the source of the authorization code stored in ApprovalCode. |
AVSResult | Contains the Address Verification System result code. |
CardLevel | This field contains a two-character code created by Visa during the authorization process. |
Code | Indicates the status of the authorization request. |
CommercialCardType | Indicates whether the credit card charged is a corporate commercial card (and if so the type of commercial card). |
CVVResult | Contains the returned CVV result code (if CVV data was sent in the request). |
RetrievalNumber | This number is to be submitted for reversals or at settlement. |
ReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
Text | Text information that describes each response code. |
TransactionDate | Local transaction date returned from the server in MMDDYY format. |
TransactionId | Contains the Transaction Identifier or MasterCard Reference Number. |
TransactionNumber | Check this field against the TransactionNumber sent in the authorization. |
TransactionTime | Local transaction time returned from the server in HHMMSS format. |
ValidationCode | Additional information generated by the card issuer. |
Balance | Available balance remaining on card. |
HostMessageId | Unique host message identifier (Reserved for future use). |
NetworkId | Identification code of the network on which the transaction was authorized. |
SettleDate | Date at which the Debit, EBT, or Gift Card transaction will settle. |
Trace | System Trace Audit Number returned for Debit transactions. |
This property is read-only.
Please refer to the TSYSDebitResponse type for a complete list of fields.SharingGroup Property (TSYSDebit Component)
List of Debit and EBT networks that the merchant supports.
Syntax
Default Value
""
Remarks
This one to 30-character property contains a listing of direct debit and EBT networks that a Point of Sale (POS) device can access. This property is provided by the signing member or processor, and the values must correspond to one of the Visa assigned direct debit network types. The following table shows the currently supported sharing groups:
1 | AFFN ATM |
5 | Visa Check Card II |
7 | ITS Shazam |
8 | Maestro |
! | ATH/Evertec |
A | Amex ATM |
B | Plus ATM |
C | CU24 |
D | Discover ATM |
E | Accel |
F | NYCE |
G | Interlink |
H | PULSE |
J | Mastercard ATM |
K | EBT |
L | Pulse |
M | STAR |
N | STAR |
O | Cirrus ATM |
Q | STAR W |
S | PULSE |
T | EBT ATM |
U | AFFN |
W | STAR SE |
Y | NYCE |
Z | STAR NE |
The value of the SharingGroup property is constructed by concatenating these values together. For instance, a value of "GWQEV5" indicates support for Interlink, STAR Southeast, Star West, Accel, Visa, and Visa Check Card II. Of these, the actual network which was used to authorize this transaction will be indicated by the NetworkId property.
SSLAcceptServerCert Property (TSYSDebit Component)
Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (TSYSDebit Component)
The certificate to be used during SSL negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (TSYSDebit Component)
This specifies the SSL/TLS implementation to use.
Syntax
public TsysdebitSSLProviders SSLProvider { get; set; }
enum TsysdebitSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As TsysdebitSSLProviders
Enum TsysdebitSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (TSYSDebit Component)
The server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.Timeout Property (TSYSDebit Component)
A timeout for the component.
Syntax
Default Value
30
Remarks
If Timeout is set to a positive value, and an operation cannot be completed immediately, the component will retry the operation for a maximum of Timeout seconds.
The default value for Timeout is 30 (seconds).
TransactionAmount Property (TSYSDebit Component)
Purchase amount to be authorized.
Syntax
Default Value
""
Remarks
This field contains the transaction amount to be authorized.
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.
TransactionNumber Property (TSYSDebit Component)
Sequence number of this transaction.
Syntax
Default Value
0
Remarks
This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the TransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.
BalanceInquiry Method (TSYSDebit Component)
Retrieves the current available balance of the debit card.
Syntax
public void BalanceInquiry();
Public Sub BalanceInquiry()
Remarks
This method sends a balance inquiry request to the Vital/TSYS transaction processor. The CardTrack2Data property must be populated with the data from the magnetic stripe on the back of the card, and both DebitPIN and DebitKSN must contain data from a certified PIN pad device. If the authorization request was successful, the Code property will contain "00", and the Balance property will contain the card's current available balance.
Config Method (TSYSDebit Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Credit Method (TSYSDebit Component)
Credits a debit card (with a customer-entered PIN).
Syntax
public void Credit();
Public Sub Credit()
Remarks
This methods sends a Credit request to the Vital/TSYS transaction processor. The CardTrack2Data property must be populated with the data from the magnetic stripe on the back of the card, and both DebitPIN and DebitKSN must contain data from a certified PIN pad device. The OriginalPurchaseDate must also contain the date at which the original Sale transaction was sent. If the authorization request was successful, the Code property will contain "00".
GetDetailAggregate Method (TSYSDebit Component)
Returns an aggregate containing details of this transaction, which is then used for settlement.
Syntax
Remarks
This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle component's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord component to do so.
Note: This method may only be called after a successful authorization. If the authorization was not successful the method throws an exception.
An example of how this method is used is shown below:
TSYSRetail.Authorize()
TSYSSettle.DetailRecords.Add(new TSYSRecordType(TSYSRetail.GetDetailAggregate()));
Interrupt Method (TSYSDebit Component)
Interrupts the current action.
Syntax
public void Interrupt();
Public Sub Interrupt()
Remarks
This method interrupts any processing that the component is currently executing.
Reset Method (TSYSDebit Component)
Clears all properties to their default values.
Syntax
public void Reset();
Public Sub Reset()
Remarks
This method clears all properties to their default values.
Sale Method (TSYSDebit Component)
Authorizes a Debit card (with a customer-entered PIN).
Syntax
public void Sale();
Public Sub Sale()
Remarks
This method sends a sale/purchase request to the Vital/TSYS transaction processor. The CardTrack2Data property must be populated with the data from the magnetic stripe on the back of the card, and both DebitPIN and DebitKSN must contain data from a certified PIN pad device. If the authorization request was successful, the Code property will contain "00".
Connected Event (TSYSDebit Component)
Fired immediately after a connection completes (or fails).
Syntax
public event OnConnectedHandler OnConnected; public delegate void OnConnectedHandler(object sender, TsysdebitConnectedEventArgs e); public class TsysdebitConnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnConnected As OnConnectedHandler Public Delegate Sub OnConnectedHandler(sender As Object, e As TsysdebitConnectedEventArgs) Public Class TsysdebitConnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
If the connection is made normally, StatusCode is 0, and Description is "OK".
If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
DataPacketIn Event (TSYSDebit Component)
Fired when receiving a data packet from the transaction server.
Syntax
public event OnDataPacketInHandler OnDataPacketIn; public delegate void OnDataPacketInHandler(object sender, TsysdebitDataPacketInEventArgs e); public class TsysdebitDataPacketInEventArgs : EventArgs { public string DataPacket { get; }
public byte[] DataPacketB { get; } }
Public Event OnDataPacketIn As OnDataPacketInHandler Public Delegate Sub OnDataPacketInHandler(sender As Object, e As TsysdebitDataPacketInEventArgs) Public Class TsysdebitDataPacketInEventArgs Inherits EventArgs Public ReadOnly Property DataPacket As String
Public ReadOnly Property DataPacketB As Byte() End Class
Remarks
This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this component.
DataPacketOut Event (TSYSDebit Component)
Fired when sending a data packet to the transaction server.
Syntax
public event OnDataPacketOutHandler OnDataPacketOut; public delegate void OnDataPacketOutHandler(object sender, TsysdebitDataPacketOutEventArgs e); public class TsysdebitDataPacketOutEventArgs : EventArgs { public string DataPacket { get; }
public byte[] DataPacketB { get; } }
Public Event OnDataPacketOut As OnDataPacketOutHandler Public Delegate Sub OnDataPacketOutHandler(sender As Object, e As TsysdebitDataPacketOutEventArgs) Public Class TsysdebitDataPacketOutEventArgs Inherits EventArgs Public ReadOnly Property DataPacket As String
Public ReadOnly Property DataPacketB As Byte() End Class
Remarks
This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this component.
Disconnected Event (TSYSDebit Component)
Fired when a connection is closed.
Syntax
public event OnDisconnectedHandler OnDisconnected; public delegate void OnDisconnectedHandler(object sender, TsysdebitDisconnectedEventArgs e); public class TsysdebitDisconnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnDisconnected As OnDisconnectedHandler Public Delegate Sub OnDisconnectedHandler(sender As Object, e As TsysdebitDisconnectedEventArgs) Public Class TsysdebitDisconnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.
Please refer to the Error Codes section for more information.
Error Event (TSYSDebit Component)
Information about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, TsysdebitErrorEventArgs e); public class TsysdebitErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As TsysdebitErrorEventArgs) Public Class TsysdebitErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
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 (TSYSDebit Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, TsysdebitSSLServerAuthenticationEventArgs e); public class TsysdebitSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As TsysdebitSSLServerAuthenticationEventArgs) Public Class TsysdebitSSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
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 (TSYSDebit Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, TsysdebitSSLStatusEventArgs e); public class TsysdebitSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As TsysdebitSSLStatusEventArgs) Public Class TsysdebitSSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
string (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
Encoded
string
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
ExpirationDate
string (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default Value: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string
Default Value: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
string (read-only)
Default Value: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
string
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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).
StoreB
byte []
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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).
StorePassword
string
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default Value: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Subject
string
Default Value: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.
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.
SubjectAltNames
string (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default Value: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default Value: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default Value: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signatures
- Key Authentication
- Key Encryption
- Data Encryption
- Key Agreement
- Certificate Signing
- Key Signing
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signatures |
0x40 | Key Authentication (Non-Repudiation) |
0x20 | Key Encryption |
0x10 | Data Encryption |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | Key Signing |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Constructors
public Certificate();
Public Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] certificateData);
Public Certificate(ByVal CertificateData As Byte())
Parses CertificateData as an X.509 public key.
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
TSYSDebitResponse Type
Contains the response to the authorization.
Remarks
This type contains the results of a transaction made with the TSYSDebit, TSYSGiftCard, or TSYSBenefit component. The fields 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 field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction has not been approved, then the contents of the field should be ignored. The ApprovalCode must be stored and submitted in the settlement data capture record.
AuthorizedAmount
string (read-only)
Default Value: ""
Amount actually used from the card (used when supporting partial redemptions).
The AuthorizedAmount represents the actual approved transaction amount when a transaction request is received from a client using the PartialRedemption option. If PartialAuthorization is set to True, then AuthorizedAmount will be the amount of the TransactionAmount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.
For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the PartialAuthorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the AuthorizedAmount will represent the approved amount of $7.50.In this case, the Code will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the AuthorizedAmount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the TransactionAmount) then this field will be "0" or "".
If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialAuthorization.
AuthSource
string (read-only)
Default Value: ""
Indicates the source of the authorization code stored in ApprovalCode.
This field contains a one character code indicating the source of the ApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes are:
Code | Description |
6 | Off-line approval: POS device generated. |
7 | Acquirer approval. |
9 | Use for non-authorized transactions; such as credit card credits |
B | Response provided by Visa Transaction Advisor Service. |
E | Off-line approval: authorization code manually keyed. |
F | CAFIS-generated response: Post-Auth.* |
G | Issuer Approval: Post-Auth.* |
H | Exceeds acquirer settlement risk exposure cap. |
N | No authorization required: Below floor limit |
L | Late clearing - authorization previously obtained (clearing beyond 30 days) |
V | Authorization obtained via VisaNet (Issuer or STIP response) |
Space | Default value, if acquirer cannot define it (MC, D, AX) |
AVSResult
string (read-only)
Default Value: ""
Contains the Address Verification System result code.
This one character field contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:
Code | Description |
0 | Approved/Declined - Address verification was not requested or it was requested but the transaction was declined (Visa, MC, Amex, Discover). |
A | Address Match - CustomerAddress matches, CustomerZip does not, or the request does not include the CustomerZip (Visa, Amex, Discover). |
I* | Ver Unavailable - Address information not verified (Discover). |
N | No match - Transaction contained postal/ZIP code only, or street address only, or postal code and street address. Also used when transaction requests AVS but sends no AVS data (Visa, MC, Amex, Discover). |
R | Retry - System unable to process (Visa, MC, Amex, Discover). |
S | Serv Unavailable - Service not supported (MC, Amex, Discover). |
U | Ver Unavailable - No data from Issuer/Authorization platform (Visa, MC, Amex, Discover). |
W | Zip Match - Nine character CustomerZip matches, CustomerAddress does not (MC, Discover). |
X | Exact Match - Nine character CustomerZip and CustomerAddress match (MC, Discover). |
Y | Exact Match - CustomerZip and CustomerAddress match (Visa, MC, Amex, Discover). |
Z | Zip Match - CustomerZip matches; CustomerAddress does not match or street address not included in the request (Visa, MC, Amex, Discover). |
1 | APPROVAL - Cardholder name and ZIP match (Amex only). |
2 | APPROVAL - Cardholder name, address, and ZIP match (Amex only). |
3 | APPROVAL - Cardholder name, address match (Amex only). |
4 | APPROVAL - Cardholder name matches (Amex only). |
5 | APPROVAL - Cardholder name incorrect, ZIP matches (Amex only). |
6 | APPROVAL - Cardholder name incorrect, address and ZIP match (Amex only). |
7 | APPROVAL - Cardholder name incorrect, address matches (Amex only). |
8 | NO MATCH - Cardholder name, address, and ZIP do not match (Amex only). |
*AVS Result Code for International addresses only
Balance
string (read-only)
Default Value: ""
Available balance remaining on card.
This field contains the Available Balance remaining on the card following the transaction that was just authorized. It represents the balance on the card prior to the transaction, minus the TransactionAmount from this transaction. For example, if a card has a $20.00 balance prior to a $15.00 ttGiftCardPurchase authorization, then the Balance will reflect an available balance of "500" ($20.00 - $15.00 = $5.00).
Note that this balance will be returned for all TransactionTypes, not just Balance Inquiries.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
Code
string (read-only)
Default Value: ""
Indicates the status of the authorization request.
This field contains a two character response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the Text to determine nature of a response message. A response code of "00" represents an approval. A response code of "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".
A list of valid result Codes are listed in the table of contents.
CVVResult
string (read-only)
Default Value: ""
Contains the returned CVV result code if it was requested.
If a CVV value was sent in the authorization request, then this one character field 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 Text 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. |
HostMessageId
string (read-only)
Default Value: ""
Unique host message identifier (Reserved for future use).
This field will contain a unique host message identifier assigned by the authorizing system and returned in Debit, EBT, and Gift card response messages. This field is reserved for future use and will most likely contain spaces.
NetworkId
string (read-only)
Default Value: ""
Identification code of the network on which the transaction was authorized.
This field indicates the network through which the transaction was authorized. If this field contains a "V" or a "5", this indicates the transaction was processed as a credit card purchase transaction even though it was originally submitted as a debit transaction. When these values ("V" or "5") are returned, the transaction must be settled as a credit card (non-debit) transaction.
The NetworkId must be printed on the customer's receipt.
The following values may be returned by the TSYS host:
1 | AFFN ATM |
5 | Visa Check Card II |
7 | ITS Shazam |
8 | Maestro |
! | ATH/Evertec |
A | Amex ATM |
B | Plus ATM |
C | CU24 |
D | Discover ATM |
E | Accel |
F | NYCE |
G | Interlink |
H | PULSE |
J | MasterCard ATM |
K | EBT |
L | Pulse |
M | STAR |
N | STAR |
O | Cirrus ATM |
Q | STAR W |
S | PULSE |
T | EBT ATM |
U | AFFN |
W | STAR SE |
Y | NYCE |
Z | STAR NE |
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 field 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 field 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 field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the TransactionId or ValidationCode fields.
SettleDate
string (read-only)
Default Value: ""
Date at which the Debit, EBT, or Gift Card transaction will settle.
This field contains a four-character transaction settlement date as returned by the TSYS Acquiring Solutions authorization system. This date is in "MMDD" format, and indicates the date at which this transaction will settle. This date does not have to match the date you actually submit this transaction in a batch settlement.
Text
string (read-only)
Default Value: ""
Text information that describes each response code.
This field 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.
Trace
string (read-only)
Default Value: ""
System Trace Audit Number returned for Debit transactions.
This field contains a unique host message identifier assigned by the authorizing system, and is returned in Debit, EBT, and Gift Card response messages.
TransactionDate
string (read-only)
Default Value: ""
Local transaction date returned from the server in MMddyy format.
This six digit field contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This field 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 field 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 field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.
TransactionNumber
string (read-only)
Default Value: ""
Check this field against the original Transaction Number.
This field 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 field 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 field contains the Local Transaction Time returned by the authorizing system. This field should be recorded and submitted in the Batch Settlement.
ValidationCode
string (read-only)
Default Value: ""
This optional field contains information generated by the card issuer.
This optional four character field contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field should be recorded and submitted as part of a Batch Settlement.
Constructors
public TSYSDebitResponse();
Public TSYSDebitResponse()
TSYSMerchant Type
Contains the merchant's setup information.
Remarks
This type contains the merchant's setup information. This includes the merchant identification, bank routing information, language, location, and other fields that identify the merchant to the TSYS server. Some of the information in these fields will be included on the customer's credit card statement, such as the merchant's Name, State, ServicePhone, etc.
Fields
BankId
string
Default Value: ""
The number which identifies the merchant's bank or processor.
This field contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This field may not remain zero-filled.
Note, the TSYS Server uses the Merchant's BankId and Number to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
CategoryCode
string
Default Value: ""
Classifies a merchant by the type of store.
This four digit field contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
City
string
Default Value: ""
Merchant's City
For Retail (Card Present) transactions, this field should contain the city in which the merchant is located. This is an optional field. However if it is specified, the Name and State must also be specified.
The first character of this field may not be a space and must contain the same data used in the batch settlement.
Note that this field is ignored for Direct Marketing and E-Commerce transactions. ServicePhone is used for those industries instead of City.
This field may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this field is 13 characters.
CountryCode
string
Default Value: "840"
Identifies the country where the merchant is located.
This field contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".
CurrencyCode
string
Default Value: "840"
Identifies the type of currency used by the merchant.
This field contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".
Language
string
Default Value: "00"
Designates the language that response messages will be returned in.
This field contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This field may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.
Indicator | Language |
00 | English. |
01 | Spanish. |
02 | Portuguese. |
03 | Reserved for Irish. |
04 | Reserved for French. |
05 | Reserved for German. |
06 | Reserved for Italian. |
07 | Reserved for Dutch. |
Name
string
Default Value: ""
Name of the merchant.
This 25 character field contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this field may not be a space. This field must contain the same value in both authorization and batch settlement.
This is an optional field. However if this field is specified, the State and City (Retail) or State and ServicePhone (E-Commerce) must also be specified.
This field may contain alphanumeric and punctuation characters. The maximum length of this field is 25 characters.
Number
string
Default Value: ""
A unique number used to identify the merchant within the VisaNet system.
This 12 digit field contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.
Note, the TSYS Server uses the Merchant's BankId and Number to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
Phone
string
Default Value: ""
Merchant's phone number.
This field contains the Merchant's business phone number. This can be the same as the customer service phone number.
ServicePhone
string
Default Value: ""
Merchant's customer service number.
This field contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.
This field is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.
State
string
Default Value: ""
State or province that the merchant is located in.
This two character field contains the merchant state or province provided by the signing member or processor. This field must contain the same data used in the batch settlement.
This is an optional field. However if it is specified the Merchant Name and City (Retail) or Name and ServicePhone (E-Commerce) must also be specified.
StoreNumber
string
Default Value: ""
Used to identify a specific merchant's store within the VisaNet system.
This four digit field contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This field must be right-justified and zero-filled.
StreetAddress
string
Default Value: ""
Merchant's street address.
This 25 character field contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.
TerminalNumber
string
Default Value: ""
Used to identify a unique terminal within a merchant location.
This four digit field contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This field must be right-justified and zero-filled.
TimeZone
string
Default Value: "705"
Specifies the GMT offset used to calculate the local time within the VisaNet system.
This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.
Byte #1:
Value | Meaning |
0 | Positive offset, in hours, ahead of GMT. |
1 | Negative offset, in hours, behind GMT. |
2 | Positive offset, in 15 minute increments, ahead of GMT. |
3 | Negative offset, in 15 minute increments, behind GMT. |
4 | Positive offset, in 15 minute increments, ahead of GMT, in cities participating in daylight savings. |
5 | Negative offset, in 15 minute increments, behind GMT, in cities participating in daylight savings. |
6 | Positive offset, in hours, ahead of GMT, in cities participating in daylight savings. |
7 | Negative offset, in hours, behind GMT, in cities participating in daylight savings. |
8-9 | RESERVED. |
If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.
Zip
string
Default Value: ""
Zip code where the merchant that initiated this transaction is located.
This field contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this field will be assigned by the signing member or processor.
This field is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the field is set.
Constructors
public TSYSMerchant();
Public TSYSMerchant()
Config Settings (TSYSDebit Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.TSYSDebit Config Settings
Valid values are:
Code | Description |
P | Pre Authorization |
F | Final Authorization |
U | Undefined Authorization |
Available values are:
Value | Description |
0 | Service code does not begin with a two or six or fill for subsequent positions that are present. |
1 | Service code begins with two or six; last CCPS read at the chip capable terminal was successful, or was not a chip transaction, or unknown. |
2 | Service code begins with two or six; last transaction at the chip capable terminal was unsuccessful chip read. |
0 | No Encryption (default) |
1 | Merchant ID and Card Data (reserved for future use) |
2 | Merchant ID, Card Data, and Card Security Code (reserved for future use) |
3 | Card Data Only |
Note you will also need to set Processor to 1 (Heartland) and HeartlandKeyBlock if you wish to process Heartland E3 transactions.
Note: This setting is only valid for Debit and EBT/Benefit transactions.
Note: This setting is only valid for Debit and EBT/Benefit transactions.
Note: This setting is only valid for Debit and EBT/Benefit transactions.
Deferred Authorizations If the merchant's Point-of-Interaction (POI) authorization system is offline and cannot process transactions, the merchant often completes the transaction with the cardholder and will then defer the authorization until their POI system is back online. Valid value is:
Code | Description |
5206 | Deferred Authorization |
Value | Description |
00 | Card (default) |
01 | Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone |
02 | Key Fob |
03 | Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO |
04 | Mobile Tag |
05 | Wristband |
06 | Mobile Phone Case or Sleeve |
07 | Mobile Phone or Smartphone with a fixed (non-removable) secure element controlled by the MNO (such as CDMA) |
08 | Removable secure element not controlled by the MNO, for example, memory card personalized for use with a mobile phone or smartphone |
09 | Mobile Phone or Smartphone with a fixed (non-removable) secure element not controlled by the MNO |
10 | MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book |
11 | Tablet or E-Book with a fixed (non-removable) secure element controlled by the MNO |
12 | Removable secure element not controlled by the MNO (such as memory card personalized for use with a tablet or e-book) |
13 | Tablet or E-Book with fixed (nonremovable) secure element not controlled by the MNO |
14 | Mobile Phone or Smartphone with a payment application running in a host processor |
15 | Tablet or E-Book with a payment application running in a host processor |
16 | Mobile Phone or Smartphone with a payment application running in the TEE of a host processor |
17 | Tablet or E-Book with a payment application running in the TEE of a host processor |
18 | Watch with a payment application running in the TEE of a host processor |
19 | Watch with a payment application running in a host processor |
20 | Card |
21 | Phone (i.e. Mobile phone) |
22 | Tablet/e-reader (i.e. Tablet computer or e-reader) |
23 | Watch/Wristband (i.e. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band) |
24 | Sticker |
25 | PC (i.e. PC or laptop) |
26 | Device Peripheral (i.e. Mobile phone case or sleeve) |
27 | Tag (i.e. Key fob or mobile tag) |
28 | Jewelry (i.e. Ring, bracelet, necklace, and cuff links) |
29 | Fashion Accessory (i.e. Handbag, bag charm, and glasses) |
30 | Garment (i.e. Dress) |
31 | Domestic Appliance (i.e. Refrigerator, washing machine) |
32 | Vehicle (i.e. Vehicle, including vehicle attached devices) |
33 | Media/Gaming Device (i.e. Media or gaming device, including a set top box, media player, and television) |
34-99 | These values reserved for future form factors. Any value in this range may occur within form factors and transaction data without prior notice. |
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: For Visa Marketplaces, the Marketplace ID must be included in this field.
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.
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.
Code Example:
TSYSRetail.Config("POSDataCode=CardholderAuthCap=1;CardInputMode=2;CardInputCap=2");
CardInputCap (Terminal card data input capability)
0 (default) | Unspecified, data not available |
1 | Manual; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader capability |
3 | Bar code/ Payment code |
4 | Optical character reader (OCR) capability, [MC, AX] |
5 | Integrated circuit card (ICC) capability and magnetic stripe reader |
6 | Key entry only capability; Mastercard recurring and installment transactions |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader and key entry capability |
C | Magnetic stripe reader, ICC, and key entry capability |
D | Magnetic stripe reader and ICC capability |
E | ICC entry capability |
H | ICC Reader and Contactless Capability; Magnetic stripe & manual entry implied |
M | PAN auto-entry via contactless chip |
V | Other capability, [MC] |
X | Reserved for private use |
CardholderAuthCap (Terminal cardholder authentication capability)
0 | No electronic authentication capability |
1 | PIN entry capability |
2 | Electronic signature analysis capability |
3 | mPOS software-based PIN entry capability |
5 | Electronic authentication capability is inoperative |
6 | Other |
9 (default) | Unspecified, data not available |
CardCaptureCap (Terminal card-capture capability)
0 | No capture capability |
1 | Card capture capability |
9 (default) | Unspecified, data not available |
TerminalOpEnv (Terminal operating environment)
0 | No terminal used; Voice auth/ARU; Mastercard recurring/installment transactions |
1 | On card acceptor premises; attended terminal |
2 | On card acceptor premises; unattended terminal |
3 | Off card acceptor premises; attended |
4 | Off card acceptor premises; unattended |
5 | On cardholder premises; unattended |
6 | Off cardholder premises; unattended |
9 (default) | Unspecified, data not available |
M | Off card acceptor premises; merchant mobile POS environment, including mPOS |
P | On card acceptor premises; merchant mobile POS environment, including mPOS |
Q | Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
R | On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
S | Electronic delivery of product, [AX] |
T | Physical delivery of product, [AX] |
CardholderPresent (Cardholder present data)
0 | Cardholder present |
1 | Cardholder not present; unspecified reason |
2 | Cardholder not present; mail transaction |
3 | Cardholder not present; phone transaction |
4 | Cardholder not present; standing (recurring) transaction |
5 | Cardholder not present; electronic commerce |
8 | Cardholder not present; recurrent billing such as a loan or installment payment |
R | Recurring purchase transaction (original transaction was token-based with valid cryptogram) |
T | PayButton (Discover only) |
CardPresent (Card present data)
0 | Card not present |
1 | Card present |
W | Transponder, [AX] |
X | Contactless Chip Transactions, including AMEX Expresspay |
Z | Digital Wallet [AX] |
CardInputMode (Card data input mode)
0 (default) | Unspecified, data not available |
1 | Manual input; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader input |
3 | Bar code/Payment code |
6 | Key entered input |
7 | Payment Credential stored on file. NOTE: This value is required for all Mastercard recurring transactions. |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader input; track data captured and passed unaltered |
C | Online Chip |
F | Offline Chip |
M | PAN auto-entry via contactless Chip Card (EMV Mode) |
N | Track data read and sent unaltered, chip capable terminal, chip data could not be read |
P | Empty candidate list fallback |
R | PAN Entry via electronic commerce, including remote chip |
S | Electronic commerce, no security, channel encrypted, or SET without cardholder certificate |
V | Manually entered with keyed CID, [AX, JCB Canada] |
W | Swiped transaction with keyed CID, [AX, JCB Canada] |
X | Reserved for private use |
Y | Reserved for private use |
Z | Contactless Interface Change Identifies when a Chip Card Transaction with a dualinterface card switches from a contactless to a contact chip card transaction [Discover] |
NOTE: AMEX defines ApplePay with value C - Online Chip
CardholderAuthMethod (Cardholder authentication method)
0 | Not authenticated |
1 | PIN |
2 | Electronic signature analysis |
5 | Manual signature verification |
6 | Other manual verification (such as a driver's license number) |
9 (default) | Unspecified, data not available |
S | Other systematic verification |
T | Electronic ticket environment, [AX] |
CardholderAuthEntity (Cardholder authentication entity)
0 | Not authenticated |
1 | ICC - Offline PIN |
2 | Card acceptance device (CAD) |
3 | Authorizing agent - Online PIN |
4 | Merchant/card acceptor - signature |
5 | Other |
9 (default) | Unspecified, data not available |
CardOutputCap (Card data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Magnetic stripe write |
3 | ICC |
S | Other |
TerminalOutputCap (Terminal data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Printing capability only |
3 | Display capability only |
4 | Printing and display capability |
PINCaptureCap (PIN capture capability)
0 | No PIN capture capability |
1 (default) | Unspecified, data not available |
2 | Reserved |
3 | Reserved |
4 | PIN capture capability four characters maximum |
5 | PIN capture capability five characters maximum |
6 | PIN capture capability six characters maximum |
7 | PIN capture capability seven characters maximum |
8 | PIN capture capability eight characters maximum |
9 | PIN capture capability nine characters maximum |
A | PIN capture capability 10 characters maximum |
B | PIN capture capability 11 characters maximum |
C | PIN capture capability 12 characters maximum |
Note: Setting this configuration setting in TSYSDetailRecord component will not update the POSDataCode tag in the detail aggregate of the original transaction.
0 | TSYS (default) |
1 | Heartland |
Note that when set, this property will set the Server and Port to the default values for the specified processor. Additionally, this config must be set prior to setting Card to ensure the card data is formatted correctly.
Byte Number | Description |
Byte 1 | Billing ZIP Code |
Byte 2 | Billing Street Match Code |
Byte 3 | Billing Name Match Code |
Byte 4 | Telephone Number Match Code |
Byte 5 | E-mail Address Match Code |
The possible values for each byte are:
Value | Description |
Y | Data Matches |
U | Data Unchecked |
N | No Match |
S | Service not allowed |
R | Retry |
' ' (Space) | Data not sent |
For Discover transactions, byte 3 will be populated with the following values:
Value | Description |
B | No response due to blank input |
K | Unknown |
P | Not processed |
M | First Name and Last Name match |
F | First Name Matches, Last Name does not match |
L | First Name does not match, Last Name matches |
N | Nothing matches |
W | No data from Issuer/Authorization system |
U | Retry, system unable to process |
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.
Note: This setting is only valid for Debit and EBT/Benefit transactions.
Base Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (TSYSDebit Component)
TSYSDebit Errors
501 Data field invalid length. | |
502 Data field invalid format. | |
503 Data field out of range. | |
504 Luhn digit check failed. | |
505 Card date invalid. | |
506 Card expired. | |
507 Card type unknown. | |
509 No gateway specified. | |
511 Invalid data entered. | |
512 Truncated response. | |
513 Invalid response. | |
517 Response length mismatch. | |
518 LRC check failed. | |
519 Corrupt response. | |
520 Response packet empty. | |
521 Response truncated. | |
522 Host disconnected. | |
523 No response from host. | |
524 Server error response. | |
526 Invalid timeout value. | |
527 Vital/TSYS returned an error response. | |
535 Signature verification failed. | |
544 Error building packet. | |
593 Missing or erroneous property value. Cannot send transaction. | |
594 Response received before transmission completed. | |
595 Prematurely disconnected (check Number and BankId). | |
596 Pending responses max number exceeded (Interleaved). | |
597 Pending response timeout (Interleaved). |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the component is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
303 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |