First Data OmniPay Retail File Batch UML

Parent: File Batch

Added On: 08/02/16

SQL Table: FIRST_DATA_OMNI_PAY_RETAIL_FILE_BATCH

Module: UniCharge

Type: Entity Status: Active

Java Class: FirstDataOmniPayRetailFileBatch

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

Available Fields:

Batch Identification Number
Confirmation Error Message
Confirmation Message
File Creation Date
File Identification
File Record Count

Institution ID
Merchant City
Merchant Classification Code
Merchant Number
Merchant State
Merchant Street Address

Net Sales Amount
PSP Name
Se Number
Summary Trans Type
Test Identifier
Total Amount

Trailer Trans Type
Use Legacy File Header

Batch Identification Number

Added On: 08/02/16

SQL Column: BATCH_IDENTIFICATION_NUMBER

Java Field: batchIdentificationNumber

Status: Active

SQL Type: varchar(23)

Java Type: String

Attributes:

BIN assigned to the merchant.

Confirmation Error Message

Added On: 08/05/16

SQL Column: CONFIRMATION_ERROR_MESSAGE

Java Field: confirmationErrorMessage

Status: Active

SQL Type: varchar(25)

Java Type: String

Attributes:

Confirmation error message generated by the processor.

Confirmation Message

Added On: 08/05/16

SQL Column: CONFIRMATION_MESSAGE

Java Field: confirmationMessage

Status: Active

SQL Type: varchar(5)

Java Type: String

Attributes:

Confirmation message generated by the processor.

File Creation Date

Added On: 08/02/16

SQL Column: FILE_CREATION_DATE

Java Field: fileCreationDate

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Date when the file was created.

File Identification

Added On: 08/02/16

SQL Column: FILE_IDENTIFICATION

Java Field: fileIdentification

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Identifier of a batch file.

File Record Count

Added On: 08/02/16

SQL Column: FILE_RECORD_COUNT

Java Field: fileRecordCount

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

Number of the records assigned to the file within the system.

Institution ID

Added On: 01/17/17

SQL Column: INSTITUTION_ID

Java Field: institutionId

Status: Active

SQL Type: varchar(7)

Java Type: String

Attributes:

Identifier of the institution assigned to the merchant.

Merchant City

Added On: 08/02/16

SQL Column: MERCHANT_CITY

Java Field: merchantCity

Status: Active

SQL Type: varchar(13)

Java Type: String

Attributes:

City of the merchant's mailing address.

Merchant Classification Code

Added On: 08/02/16

SQL Column: MERCHANT_CLASSIFICATION_CODE

Java Field: merchantClassificationCode

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

MCC assigned to the merchant.

Merchant Number

Added On: 08/02/16

SQL Column: MERCHANT_NUMBER

Java Field: merchantNumber

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

Identifier of the merchant assigned by the processor.

Merchant State

Added On: 08/02/16

SQL Column: MERCHANT_STATE

Java Field: merchantState

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

State code of the merchant's mailing address.

Merchant Street Address

Added On: 08/02/16

SQL Column: MERCHANT_STREET_ADDRESS

Java Field: merchantStreetAddress

Status: Active

SQL Type: varchar(38)

Java Type: String

Attributes:

Street of the merchant's mailing address.

Net Sales Amount

Added On: 08/02/16

SQL Column: NET_SALES_AMOUNT

Java Field: netSalesAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Value that represents total sales minus credits of preceding Bankcard and T&E Detail Addendum Record.

PSP Name

Added On: 08/02/16

SQL Column: PSP_NAME

Java Field: pspName

Status: Active

SQL Type: varchar(16)

Java Type: String

Attributes:

Name of the payment service provider associated with the merchant.

Se Number

Added On: 08/02/16

SQL Column: SE_NUMBER

Java Field: seNumber

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

Specific identifier of the merchant assigned by the processor.

Summary Trans Type

Added On: 08/04/16

SQL Column: SUMMARY_TRANS_TYPE

Java Field: summaryTransType

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

Type of the summary transaction that contains net sales amount.

Test Identifier

Added On: 08/02/16

SQL Column: TEST_IDENTIFIER

Java Field: testIdentifier

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Identifier of the merchant used for testing purposes.

Total Amount

Added On: 08/04/16

SQL Column: TOTAL_AMOUNT

Java Field: totalAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Total amount included in a batch.

Trailer Trans Type

Added On: 08/04/16

SQL Column: TRAILER_TRANS_TYPE

Java Field: trailerTransType

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

Type of the transaction that contains net amount of all preceding summary transactions.

Use Legacy File Header

Added On: 01/17/17

SQL Column: USE_LEGACY_FILE_HEADER

Java Field: useLegacyFileHeader

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes:

File header that contains Transaction Code, PSP Name, File Creation Date, File Reference, File Identification and Test/Prod Identifier.