The Net Tools Company - 800.225.4190
Search: 
Available in: TSYS
CCSettle Component [TSYS Integrator V6]

Properties   Methods   Events   Configuration Settings  

The CCSettle component is used to do a Batch Settlement on all transactions that were successfully authorized with the CCECOMMERCE or CCRETAIL components. This component may also send Level II and Level III Corporate Purchasing Card data for better interchange rates.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

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 SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated SSL servers. The CCSettle component is used to settle all transactions previously authorized by the CCECOMMERCE or CCRETAIL 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 CCSettle 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.


  CCSettle.MerchantBankId = "999995"
  CCSettle.MerchantCategoryCode = "5999"
  CCSettle.MerchantName = "test merchant"
  CCSettle.MerchantNumber = "123456789012"
  CCSettle.MerchantCity = "Beverly Hills"
  CCSettle.MerchantState = "CA"
  CCSettle.MerchantStoreNumber = "5999"
  CCSettle.MerchantTerminalNumber = "1515"
  CCSettle.MerchantZip = "90210"

Additionally, the AgentBankNumber, AgentChainNumber, TerminalId, BatchNumber, and IndustryType must be set. Note that the TerminalId is fundamentally different from the Merchant. The Merchant 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.

  CCSettle.AgentBankNumber = "000000"
  CCSettle.AgentChainNumber = "111111"
  CCSettle.TerminalId = "00000001"
  CCSettle.BatchNumber = 15
  CCSettle.IndustryType = itRetail

At this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the DetailRecords array property. First set the DetailRecordCount; to the total number of transactions you wish to settle. Each index in the DetailRecords array property must be set with the XML aggregate returned from the CCRETAIL, CCECOMMERCE, or CCDETAILRECORD component's GetDetailAggregate method.


  CCSettle.DetailRecordCount = 1
  CCSettle.DetailAggregate(0) = CCRETAIL.GetDetailAggregate()

Finally, call the SendSettlement method.


  CCSettle.SendSettlement()

If the transaction is successful, the Response will contain "GB", which indicates a "Good Batch". You should check that the Response and Response match the Batch and Batch properties.

If the transaction is not successful and you receive an "RB" Response (indicating a "Rejected Batch") the component throws an exception. You may inspect the Error. Error, Error, Error, and Error 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 increasing the DetailRecordCount and adding a transaction to each index of the DetailRecords property. 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 CCDETAILRECORD component and settled in the same manner.

To add Level II or Level III data to the settled transactions, use the DetailRecords property and the CCLEVEL2 or CCLEVEL3 components.

Note that the IndustryType from the CCSettle 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.

Property List


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

AgentBankNumberIdentifies a specific agent entity of the member bank or processor.
AgentChainNumberIdentifies a specific chain of an agent organization.
BatchCashBackTotalTotal amount of cash back for all transactions in the batch.
BatchHashingTotalTotal of purchases plus credits.
BatchNetDepositTotal of purchases minus credits.
BatchRecordCountTotal number of records sent including Header, Parameter, and Trailer.
BatchNumberSequence number of this batch transaction.
DetailRecordCountThe number of records in the DetailRecord arrays.
DetailRecordAddendumOptional Detail Record Addendum data (such as Level2 or Level3 data) The DetailAggregate property contains an xml aggregate of the transaction retrieved from the CCECOMMERCE , CCRETAIL , or CCDETAILRECORD component's GetDetailAggregate method.
DetailRecordAggregateSet this property with xml aggregates of the transactions you wish to settle.
ErrorDataErroneous data contained within the property specified by DataFieldNumber .
ErrorDataFieldNumberField within an invalid record that contains an error.
ErrorTypeType of batch error.
ErrorRecordTypeType of record in which an error occurred.
ErrorSequenceNumberSequence number of the record that caused an error.
IndustryTypeCode which indicates the industry the merchant is engaged in.
MerchantBankIdThe number which identifies the merchant's bank or processor.
MerchantCategoryCodeClassifies a merchant by the type of store.
MerchantCityMerchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
MerchantCountryCodeIdentifies the country where the merchant is located.
MerchantCurrencyCodeIdentifies the type of currency used by the merchant.
MerchantLanguageDesignates the language that response messages will be returned in.
MerchantNameName of the merchant.
MerchantNumberA unique number used to identify the merchant within the VisaNet system.
MerchantServicePhoneMerchant's customer service number.
MerchantStateState or province that the merchant is located in.
MerchantStoreNumberUsed to identify a specific merchant's store within the VisaNet system.
MerchantTerminalNumberUsed to identify a unique terminal within a merchant location.
MerchantTimeZoneSpecifies the GMT offset used to calculate the local time within the VisaNet system.
MerchantZipZip code where the merchant that initiated this transaction is located.
MerchantLocalPhoneMerchant's local phone number. Used in settlement only.
ResponseCodeIndicates the status of the batch transmission.
ResponseNetDepositTotal of purchases minus credits and voids.
ResponseNumberBatch number that belongs to this response.
ResponseRecordCountNumber of records received by the server in this batch.
ResponseTextContents of this property are dependent upon the Code .
ResponseTransmissionDateDate that the batch was settled.
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).
TerminalIdContains number to accommodate a POS device tracking number.
TimeoutA timeout for the component.

Method List


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

ConfigSets or retrieves a configuration setting.
InterruptInterrupts the current action.
ResetResets all the properties of the entire settlement to their default values.
SendSettlementBegins a Batch Settlement transaction with the transaction server.

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.

ConnectedFired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedFired when a connection is closed.
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 component with short descriptions. Click on the links for further details.

DeviceCodeA 1-character value used to identify the device and type of the merchant submitting the settlement batch.
LocationNumberProvides additional information on the location of the merchant.
PortThe port to which transactions are posted.
ServerThe server to which transactions are posted.
UseIPv6Whether or not to use IPv6.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallUserA user name if authentication is to be used connecting through a firewall.
FirewallTypeDetermines the type of firewall to connect through.
TcpNoDelayWhether or not to delay when sending packets.
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.
| About | Privacy Policy | Terms of Use |
© Copyright 2011 /n software inc.