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.
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"
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.
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.|
|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.|
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).|
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||Shows the progress of the secure connection.|
The following is a list of configuration 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.|
|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.|
|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.|
|MessageReasonCode||Code used to identify Deferred Authorizations for Visa.|
|MobileDeviceType||Identifies the type of mobile device used by the cardholder to initiate the transaction.|
|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.|
|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||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|