Elavon4 Global Retail File Batch UML


Parent:    File Batch
Added On:  06/02/16 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  Elavon4GlobalRetailFileBatch 
Elavon4 Global specific File Batch representation for the settlement process. It represents a group of Elavon4 Global Capture Retail Transaction objects that are settled together as a group within a single file.

During Generation Process, Elavon4 Global Retail File Batch is converted into a settlement file, which is then registered into File Store for further processing.
Added On:  06/02/16
SQL Column:  CREATION_DATE
Java Field:  creationDate
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
The date the file was created in the format YYMMDD where YY is the last two digit of the year, MM is the month, DD is the day of the month.
Added On:  06/02/16
SQL Column:  CREATION_TIME
Java Field:  creationTime
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
The time the file was created in the format HHNN where HH is the local hour of the day in twenty-four hour notation, and NN is the minute of the hour.
Added On:  06/02/16
SQL Column:  CURRENCY_INDICATOR_CODE
Java Field:  currencyIndicatorCode
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
A three character code which indicates the currency represented in the transaction. This field may be zeros however, is required to match the authorized response record to qualify for Visa Customer Payment Services (CPS) incentive rates. The Visa authorization system places this information in field 49.
Added On:  06/02/16
SQL Column:  CUSTOMER_SERVICE_PHONE
Java Field:  customerServicePhone
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Merchant's service phone number to discuss any processing issues.
Added On:  06/02/16
SQL Column:  EMAIL_ADDRESS
Java Field:  emailAddress
Status:  Active
SQL Type:  varchar(160)
Java Type:  String
Attributes:
Contains email address to be used for communication. Multiple addresses should be separated using ‘,’.
Added On:  06/02/16
SQL Column:  FILE_IDENTIFICATION
Java Field:  fileIdentification
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Contains an identification code assigned by Elavon. The identification code can be up to 6 positions in length. If less than six positions are assigned, the remaining positions in this field should be space filled.
Added On:  09/30/16
SQL Column:  FILE_NAME
Java Field:  fileName
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Name of the batch file.
Added On:  06/02/16
SQL Column:  MERCHANT_CITY
Java Field:  merchantCity
Status:  Active
SQL Type:  varchar(13)
Java Type:  String
Attributes:
Contains the merchant city, customer service phone number, URL or WEB address depending on the type of transaction. Card not present transactions should populate this field with either a customer service phone number, URL or WEB address. If a customer service phone number is being populated it should be left justified, 3 digits followed by a hyphen then the remaining seven digits and space fill to the right. An example would be 999-9999999ss.
Added On:  06/02/16
SQL Column:  MERCHANT_COUNTRY_CODE
Java Field:  merchantCountryCode
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Contains the merchant’s country code.
Added On:  06/08/16
SQL Column:  MERCHANT_DBA_NAME
Java Field:  merchantDbaName
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Merchant's "Doing Business As" name.
Added On:  06/02/16
SQL Column:  MERCHANT_IDENTIFICATION
Java Field:  merchantIdentification
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
U.S. Bank / Elavon will assign a specific merchant number to your account to identify the source of transactions. This field is entered at the left for a length of ten characters followed by five spaces (left justified).
Added On:  06/02/16
SQL Column:  MERCHANT_NAME
Java Field:  merchantName
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Contains the merchant name for the batch.
Added On:  06/02/16
SQL Column:  MERCHANT_STATE
Java Field:  merchantState
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Contains the merchants state.
Added On:  06/02/16
SQL Column:  MERCHANT_STREET_ADDRESS
Java Field:  merchantStreetAddress
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Contains the merchants street address.
Added On:  06/02/16
SQL Column:  MERCHANT_ZIP_CODE
Java Field:  merchantZipCode
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Contains the merchants ZIP (or postal) code.
Added On:  06/02/16
SQL Column:  NET_AMOUNT
Java Field:  netAmount
Status:  Active
SQL Type:  varchar(13)
Java Type:  String
Attributes:
Includes all items contained in the billing file and is equal to the total debit amount minus the total credit amount processed in the batch. This is a signed field.
Added On:  06/02/16
SQL Column:  PROCESSOR_BUILDING_NUMBER
Java Field:  processorBuildingNumber
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Contains the building number for the processing center.
Added On:  06/02/16
SQL Column:  PROCESSOR_CITY
Java Field:  processorCity
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Contains the city for the processing center.
Added On:  06/02/16
SQL Column:  PROCESSOR_COUNTRY
Java Field:  processorCountry
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Contains the country for the processing center.
Added On:  06/02/16
SQL Column:  PROCESSOR_ID
Java Field:  processorId
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Contains the identifier for the processor (users can populate this field with their company details).
Added On:  06/02/16
SQL Column:  PROCESSOR_NAME
Java Field:  processorName
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Contains the name for the merchant’s processor.
Added On:  06/02/16
SQL Column:  PROCESSOR_PHONE_NUMBER
Java Field:  processorPhoneNumber
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Contains the phone number for the processing center.
Added On:  06/02/16
SQL Column:  PROCESSOR_STREET_NAME
Java Field:  processorStreetName
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Contains the street name for the processing center.
Added On:  06/02/16
SQL Column:  PROCESSOR_ZIP_CODE
Java Field:  processorZipCode
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Contains the ZIP (or postal) code for the processing center.
Added On:  06/02/16
SQL Column:  SE_NUMBER
Java Field:  seNumber
Status:  Active
SQL Type:  varchar(17)
Java Type:  String
Attributes:
Contains the Service Establishment number and will contain either the Specific SE number assigned to the merchant (i.e. Discover SE, AMEX SE) or the HIMMS2-merchant number if the transaction is being processed on the international platform. This number is assigned to a merchant by Elavon and identifies the merchants profile and the settlement currency requirements. It should be noted that for each settlement currency required there will be a unique SE number assigned. This format does not support AMEX transactions from T&E merchants, for example airlines, hotels, and car rentals.
Added On:  06/02/16
SQL Column:  SETTLEMENT_AMOUNT
Java Field:  settlementAmount
Status:  Active
SQL Type:  varchar(13)
Java Type:  String
Attributes:
The total debit amount less total credit amount. This is a signed field, meaning if the file total is negative the last position of this field would contain a letter or symbol. Refer to the specification of the processor for more information.
Added On:  06/02/16
SQL Column:  SOC_NUMBER
Java Field:  socNumber
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Summary of Charge (SOC) number is a batch identifier that is created by the merchant and creates an
association to the currency of the transactions contained within each transaction currency header record batch in the file. This is used for management information and financial reporting. The SOC number must be unique for each merchant id and can only be used once within a 12 month period. This number provides the information required by the Elavon processing system to product reporting and reconciliation data.

SOC information is at a batch level and is returned to the merchant in the EPA file.

The suggested formula for the creation of the 8-digit SOC number is as follows:
  • 3 digit Julian date of the file creation + 1 digit for the year
  • 4 digit sequential number, incremented by 1 per THR record
Example for January 15, 1999 = 01590001.
Added On:  06/02/16
SQL Column:  SOC_TEXT
Java Field:  socText
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Contains the merchant Summary of Charge (SOC) text. SOC text is a 30 byte batch reference field that is populated by the merchant and used to facilitate the investigation of a merchant payment inquiry and assists the merchant in reconciliation. It is returned to the merchant in the EPA file.
Added On:  06/02/16
SQL Column:  TOTAL_CREDIT_AMOUNT
Java Field:  totalCreditAmount
Status:  Active
SQL Type:  varchar(13)
Java Type:  String
Attributes:
Total of all credit amounts in the batch. This is a signed field.
Added On:  06/02/16
SQL Column:  TOTAL_CREDIT_ITEMS
Java Field:  totalCreditItems
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Total number of all credit items in the batch
Added On:  06/02/16
SQL Column:  TOTAL_DEBIT_AMOUNT
Java Field:  totalDebitAmount
Status:  Active
SQL Type:  varchar(13)
Java Type:  String
Attributes:
Contains the total of all debit amounts in the batch. This is a signed field.
Added On:  06/02/16
SQL Column:  TOTAL_DEBIT_ITEMS
Java Field:  totalDebitItems
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Total number of all debit items (i.e., debit TAB records) in the batch
Added On:  06/02/16
SQL Column:  TOTAL_ITEM_COUNT
Java Field:  totalItemCount
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Total number of debit or credit items (i.e., number of TAB records) in the batch.
Added On:  06/02/16
SQL Column:  TOTAL_RECORD_COUNT
Java Field:  totalRecordCount
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Contains the total number of records in the file (all records including header and trailer records).