Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

TSYSHCRetail Class

Properties   Methods   Events   Configuration Settings   Errors  

The TSYSHCRetail component is used to authorize credit cards in a Retail environment, where the customer is purchasing products or services in person. This component makes authorizing these types of transactions very easy.

Class Name

InPayDirect_TSYSHCRetail

Procedural Interface

 inpaydirect_tsyshcretail_open();
 inpaydirect_tsyshcretail_close($res);
 inpaydirect_tsyshcretail_register_callback($res, $id, $function);
 inpaydirect_tsyshcretail_get_last_error($res);
 inpaydirect_tsyshcretail_get_last_error_code($res);
 inpaydirect_tsyshcretail_set($res, $id, $index, $value);
 inpaydirect_tsyshcretail_get($res, $id, $index);
 inpaydirect_tsyshcretail_do_adjusttip($res, $retrievalnumber, $originalamount, $tipamount);
 inpaydirect_tsyshcretail_do_authenticatecard($res);
 inpaydirect_tsyshcretail_do_billpayment($res);
 inpaydirect_tsyshcretail_do_config($res, $configurationstring);
 inpaydirect_tsyshcretail_do_credit($res);
 inpaydirect_tsyshcretail_do_force($res, $approvalcode, $transactiondate, $transactiontime);
 inpaydirect_tsyshcretail_do_interrupt($res);
 inpaydirect_tsyshcretail_do_reset($res);
 inpaydirect_tsyshcretail_do_sale($res);
 inpaydirect_tsyshcretail_do_voidtransaction($res, $retrievalnumber, $originalamount);

Remarks

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

The TSYSHCRetail class makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

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


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

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount and TransactionNumber. The TransactionNumber is a sequence number, and should be incremented for each transaction you send. TransactionAmount is the amount of sale formatted with an implicit decimal place.


  TSYSHCRetail1.TransactionAmount = "100"
  TSYSHCRetail1.TransactionNumber = 1

Now, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing track1, and for these cards you may use track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with track1 data.


  TSYSHCRetail1.CardMagneticStripe = "%B4444333322221111^SMITH/JOHN J         ^031210100000033301000000008000000?"
  TSYSHCRetail1.CardEntryDataSource = edsTrack1  

Finally, submit the transaction by calling one of three authorization methods: Sale, Credit, or AuthenticateCard. The following code demonstrates a purchase:

  TSYSHCRetail1.Sale()

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved, and the ResponseAVSResult indicates whether the customer's billing address on file with his credit card company matches the information presented in the CustomerAddress and CustomerZip properties. The remaining properties provide additional information about the transaction.

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

Property List


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

CaptureModeThe capture mode to be used when performing an authorization or adjustment.
CardCVVDataThree digit security code on back of card (optional).
CardCVVPresenceIndicates the presence of the card verification value.
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in Number .
CardExpYearExpiration year of the credit card specified in Number .
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number for the transaction.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
GenKeyThe unique GenKey value used to identify a POS device.
GratuityAmountThe gratuity (tip) amount of the transaction.
Level2AmexChargeDescriptorDescription of this transaction.
Level2AmexRequesterNameThe name of the requestor, if different than the cardholder.
Level2AmexShippedToZipThe zip code to which the commodity was shipped.
Level2IsTaxExemptIdentifies the characteristics of the amount appearing in TaxAmount and allows you to indicate whether the purchasing card qualifies for tax-exempt status.
Level2PurchaseOrderNumberOptional customer-specified purchase order number.
Level2TaxAmountSales tax charged in addition to the original TransactionAmount Any non-zero sales tax must have a minimum value of 0.
MerchantCategoryCodeClassifies a merchant by the type of store.
MerchantIdThe unique ID that associates the POS device with the merchant account.
RepeatIndicatorIndicates whether a transaction is a repeat of a previous transaction attempt.
ResponseAuthorizedAmountThe partial authorized amount.
ResponseBatchNumberContains the incrementing ID assigned by TSYS to identify a merchant batch.
ResponseCardTypeThe type of card sent in the authorization request.
ResponseCodeIndicates the status of the authorization request.
ResponseApprovalCodeContains an authorization code when a transaction has been approved.
ResponseAVSResultContains the Address Verification System result code.
ResponseCVVResultContains the returned CVV result code if it was requested.
ResponseRetrievalNumberThis number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
ResponseReturnedACIReturned Authorization Characteristics Indicator contains CPS qualification status.
ResponseTextText information that describes each response code.
ResponseTransactionDateLocal transaction date returned from the server in MMddyy format.
ResponseTransactionTimeLocal transaction time returned from the server in HHmmss format.
ResponseCommercialCardTypeResponse property that indicates whether the card is a commercial card.
ResponseTransactionNumberCheck this property against the original Transaction Number.
ResponseInstallmentAdviceContains the Merchant Advice Code returned by MasterCard MIP.
RoutingIdThe Routing ID assigned to the merchant by TSYS.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TransactionAmountPurchase amount to be authorized.
TransactionDescSoft (Dynamic) Descriptor.
TransactionNumberSequence number of this transaction.

Method List


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

AdjustTipSends a tip adjustment request.
AuthenticateCardSends an authentication (authorization only) request which will not be captured.
BillPaymentSends a bill payment request.
ConfigSets or retrieves a configuration setting .
CreditSends a credit request.
ForcePerforms an offline authorization request.
InterruptInterrupts the current action.
ResetClears all properties to their default values.
SaleSends a sale/purchase request.
VoidTransactionSends a void request.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

AlternateMerchantNameContains an alternate merchant/DBA name.
CashOverAmountThe Cash Over amount requested.
CashOverCurrencyThe currency used when requesting a CashOver amount.
ResponseCashOverAmountThe Cash Over amount approved.
SurchargeAmountThe transaction fee amount charged to the customer to account for acquirer-assessed surcharge.
RetrieveTokenSends a Token Only request.
RequestTokenIndicates whether to request a token for the specified card data sent in an Authorize request.
TokenThe token received from the TSYS host when a token request is sent.
TsysETBThe Encryption Transmission Block TSYS uses to decrypt encrypted data.
RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
ServerURLThe server to which transactions are posted.
LanguageIndicates the language to be used in formatting the authorization response text message.
POSCardholderPresentCardholder present data to indicate the circumstances in which card data was entered at the POS.
POSCardPresentCard present data to indicate the circumstances in which card data was entered at the POS.
POSCardInputModeCard input mode to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthMethodCardholder authentication method to indicate the circumstances in which card data was entered at the POS.
POSAuthEntityThe authentication entity to indicate the circumstances in which card data was entered at the POS.
POSCardInputCapabilityCard input capability data to indicate the circumstances in which card data was entered at the POS.
POSCardholderAuthCapabilityCardholder authentication capability data to indicate the circumstances in which card data was entered at the POS.
POSCardCaptureCapabilityCard capture capability data to indicate the circumstances in which card data was entered at the POS.
POSOperatingEnvironmentOperating environment data to indicate the circumstances in which card data was entered at the POS.
POSCardOutputCapabilityCard output capability data to indicate the circumstances in which card data was entered at the POS.
POSTerminalOutputCapabilityTerminal output capability data to indicate the circumstances in which card data was entered at the POS.
POSPINCaptureCapabilityPIN capture capability data to indicate the circumstances in which card data was entered at the POS.
POSChipConditionCodeChip condition code to indicate the circumstances in which card data was entered at the POS.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0