Elavon4 Retail File Batch UML

Parent: File Batch

Added On: 10/17/12

SQL Table: ELAVON4_RETAIL_FILE_BATCH

Module: UniCharge

Type: Entity Status: Active

Java Class: Elavon4RetailFileBatch

Elavon4 specific File Batch representation for the settlement process. It represents a group of Elavon4 Capture Retail Transaction objects that are settled together as a group within a single file.
During Generation Process, Elavon4 Retail File Batch is converted into a settlement file, which is then registered into File Store for further processing.

Available Fields:

Application Id
Batch Net Amount
Batch Net Sign
Batch Number
Batch Purchases Amount
Batch Purchases Count
Batch Return Amount
Batch Return Count
Batch Total Count
Currency Code

Customer Service Number
Elavon File Number
File Create Date
File Create Time
File Record Count
Institution Name
Merchant Category Code
Merchant City
Merchant Country
Merchant DBA Name

Merchant Email Address
Merchant ID
Merchant Phone
Merchant State
Merchant Street Address
Merchant ZIP
Originating File Name
Payment Facilitator Id
Reference Number
Sub Merchant Id

Sub Merchant Tax Id

Application Id

Added On: 05/25/18

SQL Column: APPLICATION_ID

Java Field: applicationId

Status: Active

SQL Type: varchar(8)

Java Type: String

Attributes:

Batch Net Amount

Added On: 10/17/12

SQL Column: BATCH_NET_AMOUNT

Java Field: batchNetAmount

Status: Active

SQL Type: varchar(12)

Java Type: String

Attributes:

Purchase Amount minus Return Amount (no sign) 9(10)v99.

Batch Net Sign

Added On: 10/17/12

SQL Column: BATCH_NET_SIGN

Java Field: batchNetSign

Status: Active

SQL Type: varchar(1)

Java Type: String

Attributes:

The “+” or “–“ character depending on sign of Batch Net Amount field.

Batch Number

Added On: 10/17/12

SQL Column: BATCH_NUMBER

Java Field: batchNumber

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

This value is assigned by the Elavon host and will be returned in the authorization and batch response messages. For Terminal-Based authorization response messages, the batch number will be zero (0).

Batch Purchases Amount

Added On: 10/17/12

SQL Column: BATCH_PURCHASES_AMOUNT

Java Field: batchPurchasesAmount

Status: Active

SQL Type: varchar(12)

Java Type: String

Attributes:

The total dollar amount of purchase transactions for the batch in 9(10)v99 format.

Batch Purchases Count

Added On: 10/17/12

SQL Column: BATCH_PURCHASES_COUNT

Java Field: batchPurchasesCount

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

The count of purchase transactions for the batch.

Batch Return Amount

Added On: 10/17/12

SQL Column: BATCH_RETURN_AMOUNT

Java Field: batchReturnAmount

Status: Active

SQL Type: varchar(12)

Java Type: String

Attributes:

The total dollar amount of return transactions for the batch in 9(10)v99 format.

Batch Return Count

Added On: 10/17/12

SQL Column: BATCH_RETURN_COUNT

Java Field: batchReturnCount

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

The count of return transactions for the batch.

Batch Total Count

Added On: 10/17/12

SQL Column: BATCH_TOTAL_COUNT

Java Field: batchTotalCount

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

The total count of all transactions in the batch.

Currency Code

Added On: 10/17/12

SQL Column: CURRENCY_CODE

Java Field: currencyCode

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

This value is ISO Currency Code used in the Foreign Exchange Rate message.

Customer Service Number

Added On: 10/17/12

SQL Column: CUSTOMER_SERVICE_NUMBER

Java Field: customerServiceNumber

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

Customer service telephone number.

Elavon File Number

Added On: 10/17/12

SQL Column: ELAVON_FILE_NUMBER

Java Field: elavonFileNumber

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Same as file number in “& FILEID” record.

File Create Date

Added On: 10/17/12

SQL Column: FILE_CREATE_DATE

Java Field: fileCreateDate

Status: Active

SQL Type: varchar(8)

Java Type: String

Attributes:

The date of actual file creation.
YYYYMMDD (same as file header).

File Create Time

Added On: 10/17/12

SQL Column: FILE_CREATE_TIME

Java Field: fileCreateTime

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

The time of actual file creation (format: HHMMSS).

File Record Count

Added On: 10/17/12

SQL Column: FILE_RECORD_COUNT

Java Field: fileRecordCount

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

Number of physical records in the file.

Institution Name

Added On: 10/17/12

SQL Column: INSTITUTION_NAME

Java Field: institutionName

Status: Active

SQL Type: varchar(25)

Java Type: String

Attributes:

User assigned.

Merchant Category Code

Added On: 05/25/18

SQL Column: MERCHANT_CATEGORY_CODE

Java Field: merchantCategoryCode

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Merchant City

Added On: 10/17/12

SQL Column: MERCHANT_CITY

Java Field: merchantCity

Status: Active

SQL Type: varchar(13)

Java Type: String

Attributes:

The city of the merchant's mailing address.

Merchant Country

Added On: 10/17/12

SQL Column: MERCHANT_COUNTRY

Java Field: merchantCountry

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

The country of the merchant's mailing address.

Merchant DBA Name

Added On: 10/17/12

SQL Column: MERCHANT_DBA_NAME

Java Field: merchantDbaName

Status: Active

SQL Type: varchar(25)

Java Type: String

Attributes:

This value allows the merchant to change the “Doing Business As” name on each transaction submitted to the host for authorization and settlement.

The use of the dynamic DBA (dDBA) field is restricted by Elavon and requires prior approval to participate in the program. Values that are sent in this field by merchants that are not approved for use of this field will be ignored by the host prior to authorization and the value currently “on file” with Elavon will be used.

Merchant Email Address

Added On: 05/25/18

SQL Column: MERCHANT_EMAIL_ADDRESS

Java Field: merchantEmailAddress

Status: Active

SQL Type: varchar(40)

Java Type: String

Attributes:

Merchant ID

Added On: 10/17/12

SQL Column: MERCHANT_ID

Java Field: merchantId

Status: Active

SQL Type: varchar(15)

Java Type: String

Attributes:

Identification number of the merchant. Left-justified with trailing spaces.

Merchant Phone

Added On: 05/25/18

SQL Column: MERCHANT_PHONE

Java Field: merchantPhone

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

Merchant State

Added On: 10/17/12

SQL Column: MERCHANT_STATE

Java Field: merchantState

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

The state code of the merchant's mailing address.

Merchant Street Address

Added On: 04/24/13

SQL Column: MERCHANT_STREET_ADDRESS

Java Field: merchantStreetAddress

Status: Active

SQL Type: varchar(30)

Java Type: String

Attributes:

The street of the merchant's mailing address.

Merchant ZIP

Added On: 10/17/12

SQL Column: MERCHANT_ZIP

Java Field: merchantZip

Status: Active

SQL Type: varchar(9)

Java Type: String

Attributes:

The ZIP/postal code of the merchant's mailing address.

Originating File Name

Added On: 10/17/12

SQL Column: ORIGINATING_FILE_NAME

Java Field: originatingFileName

Status: Active

SQL Type: varchar(32)

Java Type: String

Attributes:

The name of original submitted file.

Payment Facilitator Id

Added On: 05/25/18

SQL Column: PAYMENT_FACILITATOR_ID

Java Field: paymentFacilitatorId

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Reference Number

Added On: 10/17/12

SQL Column: REFERENCE_NUMBER

Java Field: referenceNumber

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

This value is a reference number assigned by Elavon and returned in the authorization response message.

Sub Merchant Id

Added On: 05/25/18

SQL Column: SUB_MERCHANT_ID

Java Field: subMerchantId

Status: Active

SQL Type: varchar(15)

Java Type: String

Attributes:

Sub Merchant Tax Id

Added On: 05/25/18

SQL Column: SUB_MERCHANT_TAX_ID

Java Field: subMerchantTaxId

Status: Active

SQL Type: varchar(14)

Java Type: String

Attributes: