TSYS Retail File Batch                                                    UML
                                
         
     
    
    
    
    
        
            Added On:  02/13/12 
        
        
        
            Module:  UniCharge 
        
     
    
        
            Type:  Entity 
            Status:  Active 
        
        
                            Java Class:  TsysRetailFileBatch 
                    
        
        
     
    
        
        
                    
                        
                Added On:  02/13/12
                SQL Column:  ACQUIRER_BIN
                Java Field:  acquirerBin
             
            
                Status:  Active
                SQL Type:  varchar(6)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains Bank Identification Number (BIN) issued by the merchant’s member bank or processor. The Acquirer Bank Identification Number identifies the member bank or processor that signed the merchant using the POS application.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  AGENT_BANK_NUMBER
                Java Field:  agentBankNumber
             
            
                Status:  Active
                SQL Type:  varchar(6)
                Java Type:  String
             
            
            
            
                
                    
                        
                        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.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  AGENT_CHAIN_NUMBER
                Java Field:  agentChainNumber
             
            
                Status:  Active
                SQL Type:  varchar(6)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field is issued by the merchant’s member bank or processor for purposes of identifying a specific chain of an agent organization.                        
                     
                 
             
                    
                        
                Added On:  03/27/12
                SQL Column:  APPLICATION_TYPE
                Java Field:  applicationType
             
            
                Status:  Active
                SQL Type:  varchar(1)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The TSYS Acquiring Solutions authorization system supports a number of communication interface applications.
These applications include:
• Single Transaction: a half-duplex, single-threaded interface option where only one authorization is performed per host connection.
• Multi-Transaction: a half-duplex, single-threaded interface option where multiple authorizations can be performed per host connection.
• Interleaved: A full-duplex multi-threaded interface option where multiple transactions are performed per host connection.
Refer to the EIS 1051 (Authorization Link Level Protocol) specification for additional information on these communication applications.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  BATCH_HASHING_TOTAL
                Java Field:  batchHashingTotal
             
            
                Status:  Active
                SQL Type:  varchar(16)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The Hashing total is the gross dollar amount of the batch and is generated by adding together the absolute value of all Detail record amounts. 
Void and purchase return settlement amounts are treated as positive and added to the total, not subtracted from it.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  BATCH_NET_DEPOSIT
                Java Field:  batchNetDeposit
             
            
                Status:  Active
                SQL Type:  varchar(16)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The net deposit total is generated by adding the settlement amounts of all Detail transaction records and subtracting credit or refund amounts from it. 
Void transaction amounts are not factored into this amount.
This field is represented as an “absolute value.”                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  BATCH_NUMBER
                Java Field:  batchNumber
             
            
                Status:  Active
                SQL Type:  varchar(3)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains a batch sequence number generated by the POS device.
The batch number must be a number within the range of 001-999. If the POS device is automatically incrementing the batch number, it should automatically advance the number from 999 to 001 (000 is invalid). Batch Numbers must not be reused or repeated within five
consecutive days.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  BATCH_RECORD_COUNT
                Java Field:  batchRecordCount
             
            
                Status:  Active
                SQL Type:  varchar(9)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains a batch record count calculated by the point of sale device. 
This field is supplied in the Batch Trailer record and must contain the total number of records in the batch – including Header, Parameter, Detail(s), and Trailer records. 
Blocking has no effect upon the record count.
When this field is returned by the host in a batch response message, it will reflect the total number of records having been received by the host. In the case of a GB (Good Batch) response, the value returned should match the value supplied. However, in the case of an RB (Rejected Batch) response, the batch record count will reflect the total number of records received until the point of failure. Hence, the returned record count will reveal the sequential number of the record responsible for causing a rejected batch condition.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  BATCH_RESPONSE_CODE
                Java Field:  batchResponseCode
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the response code returned by the host indicating the status                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  BATCH_RESPONSE_TEXT
                Java Field:  batchResponseText
             
            
                Status:  Active
                SQL Type:  varchar(250)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field will contain the text “_ACCEPTED” when a settlement batch has been successfully received by the host; however, the POS device should examine only the Batch Response code to determine the status of particular batch status.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  BATCH_TRANSMISSION_DATE
                Java Field:  batchTransmissionDate
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the transmission date of the settlement batch. The
transmission date must be provided in MMDD format.                        
                     
                 
             
                    
                        
                Added On:  04/30/13
                SQL Column:  CASH_BACK_TOTAL
                Java Field:  cashBackTotal
             
            
                Status:  Active
                SQL Type:  varchar(16)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This fixed 16-character numeric field contains the total sum of cash back amount.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  CITY_CODE
                Java Field:  cityCode
             
            
                Status:  Active
                SQL Type:  varchar(9)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field is used to identify the merchant Postal/ZIP Code.
This field entry must be identical to the value provided in the original authorization request.                        
                     
                 
             
                    
                        
                Added On:  05/19/21
                SQL Column:  COUNTRY_CODE
                Java Field:  countryCode
             
            
                Status:  Active
                SQL Type:  varchar(3)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  05/19/21
                SQL Column:  CURRENCY_CODE
                Java Field:  currencyCode
             
            
                Status:  Active
                SQL Type:  varchar(3)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  02/13/12
                SQL Column:  DUPLICATE_BATCH_TRANSMISSION_DATE
                Java Field:  duplicateBatchTransmissionDate
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The date of duplicate batch transmission.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  ERROR_DATA
                Java Field:  errorData
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the error data contained within the field which generated the rejected batch response message. 
This information can be useful in identifying and correcting the rejected batch condition.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  ERROR_DATA_FIELD_NUMBER
                Java Field:  errorDataFieldNumber
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the sequential field number within the data record which generated the rejected batch response message                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  ERROR_RECORD_SEQUENCE_NUMBER
                Java Field:  errorRecordSequenceNumber
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the sequential number of the data record which caused the rejected batch state                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  ERROR_RECORD_TYPE
                Java Field:  errorRecordType
             
            
                Status:  Active
                SQL Type:  varchar(1)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field defines the data record which generated the rejected batch response message                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  ERROR_TYPE
                Java Field:  errorType
             
            
                Status:  Active
                SQL Type:  varchar(1)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field defines the nature of a rejected batch.                        
                     
                 
             
                    
                        
                Added On:  07/02/20
                SQL Column:  GROUP3
                Java Field:  group3
             
            
                Status:  Active
                SQL Type:  varchar(12)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  11/10/14
                SQL Column:  GROUP5
                Java Field:  group5
             
            
                Status:  Active
                SQL Type:  varchar(10)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Authorization request and response message data elements are separated into functional data groupings. 
TSYS Acquiring Solutions currently defines and supports three separate data groupings for both authorization request and response messages.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  GROUP2
                Java Field:  group2
             
            
                Status:  Active
                SQL Type:  varchar(38)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Group II fields are directly associated with performing Direct Debit transactions. To perform a Debit Card transaction, Group II data elements must be combined and concatenated with Base Group I and III. When Groups I, II, and III are supplied in the authorization request, the host responds with a corresponding set of Group I, II, and III response fields.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  INDUSTRY_CODE
                Java Field:  industryCode
             
            
                Status:  Active
                SQL Type:  varchar(1)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field used to identify the industry type of the merchant submitting the settlement batch                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  MERCHANT_CATEGORY_CODE
                Java Field:  merchantCategoryCode
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field used to identify a merchant’s industry classification                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  MERCHANT_CITY
                Java Field:  merchantCity
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the merchant city as provided to the bank or processor. The Merchant Location provided will appear on the cardholder’s statement. If the merchant is categorized as a Direct Marketer, this field should contain a Cardholder Service Phone Number (a merchant telephone number that the cardholder may call for service)                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  MERCHANT_LOCATION_NUMBER
                Java Field:  merchantLocationNumber
             
            
                Status:  Active
                SQL Type:  varchar(5)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains a value providing additional information on the location of the merchant                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  MERCHANT_NAME
                Java Field:  merchantName
             
            
                Status:  Active
                SQL Type:  varchar(25)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the merchant name as provided to the bank or processor. The Merchant Name provided will appear on the cardholder’s statement.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  MERCHANT_NUMBER
                Java Field:  merchantNumber
             
            
                Status:  Active
                SQL Type:  varchar(12)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field used to identify the merchant within the member systems.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  MERCHANT_STATE
                Java Field:  merchantState
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the merchant state as provided to the bank or processor. 
The Merchant State/Province provided will appear on the cardholder’s statement.                        
                     
                 
             
                    
                        
                Added On:  06/17/16
                SQL Column:  PROVIDER_CHARGE_TRANSACTIONS_FK
                Java Field:  providerChargeTransactions
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                    
                        
                Added On:  02/13/12
                SQL Column:  RECORD_TYPE
                Java Field:  recordType
             
            
                Status:  Active
                SQL Type:  varchar(5)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field is used to define the characteristics of a settlement record being submitted for processing on the TSYS Acquiring Solutions system.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  STORE_NUMBER
                Java Field:  storeNumber
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field is used to identify a specific merchant store location within the member systems.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  TERMINAL_ID_NUMBER
                Java Field:  terminalIdNumber
             
            
                Status:  Active
                SQL Type:  varchar(8)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains the number to accommodate a POS device tracking number                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  TERMINAL_NUMBER
                Java Field:  terminalNumber
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field contains a number used to identify a specific store terminal within the member systems.                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  TIME_ZONE_DIFFERENTIAL
                Java Field:  timeZoneDifferential
             
            
                Status:  Active
                SQL Type:  varchar(3)
                Java Type:  String
             
            
            
            
                
                    
                        
                        This field used to calculate the local time within the TSYS Acquiring Solutions authorization system. 
The differential is assigned by the merchant’s bank or processor and provides the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two-character numeric specifies the magnitude of the differential.