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

TibcTSYSDebit

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.

Method List

---

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

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.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AgentBankNumber Property (TSYSDebit Component)

Identifies a specific agent entity of the member bank or processor.

Syntax

property AgentBankNumber: String read get_AgentBankNumber write set_AgentBankNumber;

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

property AgentChainNumber: String read get_AgentChainNumber write set_AgentChainNumber;

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

property BatchNumber: Integer read get_BatchNumber write set_BatchNumber;

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

property CardTrack2Data: String read get_CardTrack2Data write set_CardTrack2Data;

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

property CashBackAmount: String read get_CashBackAmount write set_CashBackAmount;

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

property DebitKSN: String read get_DebitKSN write set_DebitKSN;

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

property DebitPIN: String read get_DebitPIN write set_DebitPIN;

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

property IndustryType: TibcTSYSIndustryTypes read get_IndustryType write set_IndustryType;

TibcTSYSIndustryTypes = (
  sitUnknown,
  sitRetail,
  sitRestaurant,
  sitGroceryStore,
  sitDirectMarketing,
  sitHotel,
  sitAutoRental,
  sitPassengerTransport
);

Default Value

sitRetail

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.

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

property Merchant: TibcTSYSMerchant read get_Merchant write set_Merchant;

Remarks

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

Please refer to the TSYSMerchant type for a complete list of fields.

MerchantABANumber Property (TSYSDebit Component)

Merchant's routing number.

Syntax

property MerchantABANumber: String read get_MerchantABANumber write set_MerchantABANumber;

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

property MerchantSettlementAgent: String read get_MerchantSettlementAgent write set_MerchantSettlementAgent;

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

property OriginalPurchaseDate: String read get_OriginalPurchaseDate write set_OriginalPurchaseDate;

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

property ReimbursementAttribute: TibcTSYSReimbursementAttributes read get_ReimbursementAttribute write set_ReimbursementAttribute;

TibcTSYSReimbursementAttributes = (
  raStandardRetail,
  raQualifiedGrocery,
  raPreExistingRetail,
  raPreExistingGrocery,
  raNonDebit,
  raTaxExempt
);

Default Value

raStandardRetail

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:

Response Property (TSYSDebit Component)

Contains the response to a debit authorization request.

Syntax

property Response: TibcTSYSDebitResponse read get_Response;

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:

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

property SharingGroup: String read get_SharingGroup write set_SharingGroup;

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:

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.

SSLAcceptServerCertEncoded Property (TSYSDebit Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded;
property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties 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.

This property is not available at design time.

SSLCertEncoded Property (TSYSDebit Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded;
property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties 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.

This property is not available at design time.

SSLCertStore Property (TSYSDebit Component)

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

Syntax

property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore;
property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;

Default Value

'MY'

Remarks

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

The StoreType property 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 property 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 property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

SSLCertStorePassword Property (TSYSDebit Component)

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

Syntax

property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;

Default Value

''

Remarks

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

SSLCertStoreType Property (TSYSDebit Component)

This is the type of certificate store for this certificate.

Syntax

property SSLCertStoreType: TibcCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;

TibcCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

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 property can take one of the following values:

SSLCertSubject Property (TSYSDebit Component)

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

Syntax

property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;

Default Value

''

Remarks

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

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

SSLProvider Property (TSYSDebit Component)

This specifies the SSL/TLS implementation to use.

Syntax

property SSLProvider: TibcTSSLProviders read get_SSLProvider write set_SSLProvider;

TibcTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

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:

Additional Notes

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.

SSLServerCertEncoded Property (TSYSDebit Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLServerCertEncoded: String read get_SSLServerCertEncoded;
property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties 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.

This property is read-only and not available at design time.

Timeout Property (TSYSDebit Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

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

property TransactionAmount: String read get_TransactionAmount write set_TransactionAmount;

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

property TransactionNumber: Integer read get_TransactionNumber write set_TransactionNumber;

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

procedure 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

function Config(ConfigurationString: String): String;

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

procedure 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

function GetDetailAggregate(): String;

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 raises an exception.

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

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

Interrupt Method (TSYSDebit Component)

Interrupts the current action.

Syntax

procedure 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

procedure 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

procedure 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

type TConnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

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

type TDataPacketInEvent = procedure (
  Sender: TObject;
  DataPacket: String;
  DataPacketB: TBytes
) of Object;

property OnDataPacketIn: TDataPacketInEvent read FOnDataPacketIn write FOnDataPacketIn;

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

type TDataPacketOutEvent = procedure (
  Sender: TObject;
  DataPacket: String;
  DataPacketB: TBytes
) of Object;

property OnDataPacketOut: TDataPacketOutEvent read FOnDataPacketOut write FOnDataPacketOut;

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

type TDisconnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

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

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

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

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  CertEncoded: String;
  CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

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

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

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

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 properties contained by this type are listed below.

Fields

Constructors

constructor Create();

TSYSMerchant Type

Contains the merchant's setup information.

Remarks

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

Fields

Constructors

constructor Create();

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

Base Config Settings

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.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

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

TCP/IP Errors

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