The TSYSSettle component is used to do a Batch Settlement on all transactions that were successfully authorized with the TSYSECOMMERCE or TSYSRETAIL components. This component may also send Level II and Level III Corporate Purchasing Card data for better interchange rates.
This component allows for a direct, secure connection to the Vital/TSYS gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers. The TSYSSettle component is used to settle all transactions previously authorized by the TSYSECommerce or TSYSRetail component. When a transaction is authorized, money in the customer's account is blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions are settled with the TSYSSettle component the funds are deducted from the customer's account and added to the merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement.
To send a Batch Settlement, first the user must fill out the Merchant properties with the same information contained in the authorizing component's Merchant properties.
TSYSSettle.Merchant.BankId = "999995" TSYSSettle.Merchant.CategoryCode = "5999" TSYSSettle.Merchant.Name = "test merchant" TSYSSettle.Merchant.Number = "123456789012" TSYSSettle.Merchant.City = "Beverly Hills" TSYSSettle.Merchant.State = "CA" TSYSSettle.Merchant.StoreNumber = "5999" TSYSSettle.Merchant.TerminalNumber = "1515" TSYSSettle.Merchant.Zip = "90210"
Additionally, the AgentBankNumber, AgentChainNumber, TerminalId, BatchNumber, and IndustryType
must be set. Note that the TerminalId is fundamentally different from the TerminalNumber. The
TerminalNumber is used to identify a unique terminal (PC, server, whatever) within a merchant location.
The TerminalId, also known as the "V Number", is used for point-of-sale tracking.
TSYSSettle.AgentBankNumber = "000000" TSYSSettle.AgentChainNumber = "111111" TSYSSettle.TerminalId = "00000001" TSYSSettle.BatchNumber = 15 TSYSSettle.IndustryType = itRetail
At this point, you are ready to add transactions to the batch settlement. Each successfully authorized transaction to be settled must
be added to the DetailRecords collection. The DetailRecords collection contains TSYSRecordType types, which consist of a
a DetailAggregate and AddendumAggregate field. The DetailAggregate field should be set with the XML aggregate returned from the TSYSRetail,
TSYSECommerce, or TSYSDetailRecord component's GetDetailAggregate method. The AddendumAggregate is used when
passing additional commercial card addendum data with the settlement, and is not used for regular credit card transactions.
TSYSSettle.DetailRecords.Add(new TSYSRecordType()); TSYSSettle.DetailRecords.DetailAggregate = TSYSRetail.GetDetailAggregate();
Finally, call the SendSettlement method.
If the transaction is not successful and you receive an "RB" Code (indicating a "Rejected Batch") the component throws an exception. You may inspect the Data. DataFieldNumber, RecordType, SequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.
Thousands of detail records may be settled in the above manner, just by adding transactions to the DetailRecords collection. However it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.
To Void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. Credits and forced transactions may be created using the TSYSDetailRecord component and settled in the same manner.
Note that the IndustryType from the TSYSSettle component MUST match the detail record aggregate of EACH transaction that is added to the settlement. You cannot mix industry types in a batch - you must settle a separate batch for each industry type.
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.|
|Batch||Contains information about the batch settlement, as computed by the component.|
|BatchNumber||Sequence number of this batch transaction.|
|DetailRecords||Collection of detail records to send in the settlement.|
|Error||Contains information about settlement errors.|
|IndustryType||Code which indicates the industry the merchant is engaged in.|
|Merchant||Contains the merchant's setup information.|
|MerchantLocalPhone||Merchant's local phone number. Used in settlement only.|
|Response||Contains the response to a batch settlement.|
|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.|
|TerminalId||Contains number to accommodate a POS device tracking number.|
|Timeout||A timeout for the component.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting .|
|Interrupt||Interrupts the current action.|
|Reset||Resets all the properties of the entire settlement to their default values.|
|SendSettlement||Begins a Batch Settlement transaction with the transaction server.|
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.
|CombineRecords||Whether settlement records are being concatenated into a single settlement block.|
|TravelAgencyCode||Contains the Travel Agency IATA Code if the ticket was issued by a travel agency.|
|TravelAgencyName||Contains the Travel Agency Name if the ticket was issued by a travel agency.|
|DeviceCode||A 1-character value used to identify the device and type of the merchant submitting the settlement batch.|
|LocationNumber||Provides additional information on the location of the merchant.|
|Port||The port to which transactions are posted.|
|Server||The server to which transactions are posted.|
|GenKey||A randomly generated string of alphanumeric characters identifying the terminal.|
|Processor||Specifies the Processor you are connecting to.|
|HeartlandEncryptionMode||Specifies the encryption mode to use in Heartland transactions.|
|HeartlandDeviceId||Specifies a device ID to uniquely identify each terminal (card data entry device).|
|HeartlandKeyBlock||Specifies the key block used to encrypt the data.|
|ConnectionTimeout||Sets a separate timeout value for establishing a connection.|
|FirewallAutoDetect||Tells the component whether or not to automatically detect and use firewall system settings, if available.|
|FirewallHost||Name or IP address of firewall (optional).|
|FirewallListener||If true, the component binds to a SOCKS firewall as a server (IPPort only).|
|FirewallPassword||Password to be used if authentication is to be used when connecting through the firewall.|
|FirewallPort||The TCP port for the FirewallHost;.|
|FirewallType||Determines the type of firewall to connect through.|
|FirewallUser||A user name if authentication is to be used connecting through a firewall.|
|KeepAliveTime||The inactivity time in milliseconds before a TCP keep-alive packet is sent.|
|KeepAliveInterval||The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.|
|Linger||When set to True, connections are terminated gracefully.|
|LingerTime||Time in seconds to have the connection linger.|
|LocalHost||The name of the local host through which connections are initiated or accepted.|
|LocalPort||The port in the local host where the component binds.|
|MaxLineLength||The maximum amount of data to accumulate when no EOL is found.|
|MaxTransferRate||The transfer rate limit in bytes per second.|
|ProxyExceptionsList||A semicolon separated list of hosts and IPs to bypass when using a proxy.|
|TCPKeepAlive||Determines whether or not the keep alive socket option is enabled.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|CACertFilePaths||The paths to CA certificate files when using Mono on Unix/Linux.|
|ReuseSSLSession||Determines if the SSL session is reused.|
|SSLCipherStrength||The minimum cipher strength used for bulk encryption.|
|SSLEnabledProtocols||Used to enable/disable the supported security protocols.|
|SSLIncludeCertChain||Whether the entire certificate chain is included in the SSLServerAuthentication event.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|TLS12SignatureAlgorithms||Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.|
|TLS12SupportedGroups||The supported groups for ECC.|
|TLS13KeyShareGroups||The groups for which to pregenerate key shares.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|AbsoluteTimeout||Determines whether timeouts are inactivity timeouts or absolute timeouts.|
|FirewallData||Used to send extra data to the firewall.|
|InBufferSize||The size in bytes of the incoming queue of the socket.|
|OutBufferSize||The size in bytes of the outgoing queue of the socket.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|UseBackgroundThread||Whether threads created by the component are background threads.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|