First Data Compass Retail File Batch UML

Parent: File Batch

Added On: 02/13/12

SQL Table: FIRST_DATA_COMPASS_RETAIL_FILE_BATCH

Module: UniCharge

Type: Entity Status: Active

Java Class: FirstDataCompassRetailFileBatch

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

Available Fields:

Batch Record Count
Creation Date
Customer Service Phone Number
File Record Count
Merchant Category Code
Merchant City
Merchant Country Code
Merchant Id

Merchant Name
Merchant Postal Code
Merchant Region
Merchant Space
Merchant Street
Order Count
PID
PID Password

Refunds Amount
Sales Amount
SID
SID Password
Submission Number
Token Type
Total Amount
TPP ID

Unique File Id

Batch Record Count

Added On: 02/13/12

SQL Column: BATCH_RECORD_COUNT

Java Field: batchRecordCount

Status: Active

SQL Type: varchar(9)

Java Type: String

Attributes:

Total number of records in the batch up to, but NOT including, the Batch Totals Record.

Creation Date

Added On: 02/13/12

SQL Column: CREATION_DATE

Java Field: creationDate

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

Date the file was created. YYMMDD format

Customer Service Phone Number

Added On: 02/13/12

SQL Column: CUSTOMER_SERVICE_PHONE_NUMBER

Java Field: customerServicePhoneNumber

Status: Active

SQL Type: varchar(13)

Java Type: String

Attributes:

Customer Service Phone Number

File Record Count

Added On: 02/13/12

SQL Column: FILE_RECORD_COUNT

Java Field: fileRecordCount

Status: Active

SQL Type: varchar(9)

Java Type: String

Attributes:

Total number of records in the file up to, but NOT including, the current Record.

Merchant Category Code

Added On: 11/30/17

SQL Column: MERCHANT_CATEGORY_CODE

Java Field: merchantCategoryCode

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Merchant City

Added On: 11/30/17

SQL Column: MERCHANT_CITY

Java Field: merchantCity

Status: Active

SQL Type: varchar(21)

Java Type: String

Attributes:

Merchant Country Code

Added On: 02/17/15

SQL Column: MERCHANT_COUNTRY_CODE

Java Field: merchantCountryCode

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

Country code of the merchant's postal address.

Merchant Id

Added On: 11/30/17

SQL Column: MERCHANT_ID

Java Field: merchantId

Status: Active

SQL Type: varchar(15)

Java Type: String

Attributes:

Merchant Name

Added On: 02/13/12

SQL Column: MERCHANT_NAME

Java Field: merchantName

Status: Active

SQL Type: varchar(22)

Java Type: String

Attributes:

Descriptor that will appear on the cardholder’s statement. If this field is blank the descriptor is reset to the default at the division level.

Merchant Postal Code

Added On: 02/17/15

SQL Column: MERCHANT_POSTAL_CODE

Java Field: merchantPostalCode

Status: Active

SQL Type: varchar(15)

Java Type: String

Attributes:

ZIP code of the merchant's postal address.

Merchant Region

Added On: 02/17/15

SQL Column: MERCHANT_REGION

Java Field: merchantRegion

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

Region of the merchant's postal address.

Merchant Space

Added On: 02/13/12

SQL Column: MERCHANT_SPACE

Java Field: merchantSpace

Status: Active

SQL Type: varchar(8)

Java Type: String

Attributes:

For merchant use. Unique file identifier supplied by merchant.
This data is returned with the reply file.

Merchant Street

Added On: 02/17/15

SQL Column: MERCHANT_STREET

Java Field: merchantStreet

Status: Active

SQL Type: varchar(38)

Java Type: String

Attributes:

Street of the merchant's postal address.

Order Count

Added On: 02/13/12

SQL Column: ORDER_COUNT

Java Field: orderCount

Status: Active

SQL Type: varchar(9)

Java Type: String

Attributes:

Total number of all orders within this batch.

PID

Added On: 02/13/12

SQL Column: PID

Java Field: pid

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

Presenter’s ID (PID). Assigned by First Data.
The PID is a number assigned to the location that physically sends the data file (Presenter).

PID Password

Added On: 06/14/16

SQL Column:

Java Field: pidPassword

Status: Active

SQL Type:

Java Type: String

Attributes: Transient

Refunds Amount

Added On: 02/13/12

SQL Column: REFUNDS_AMOUNT

Java Field: refundsAmount

Status: Active

SQL Type: varchar(14)

Java Type: String

Attributes:

Total amount of the refund transaction.

Sales Amount

Added On: 02/13/12

SQL Column: SALES_AMOUNT

Java Field: salesAmount

Status: Active

SQL Type: varchar(14)

Java Type: String

Attributes:

Total amount of the sales transaction.

SID

Added On: 02/13/12

SQL Column: SID

Java Field: sid

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

Submitter’s ID (SID). Assigned by First Data.

SID Password

Added On: 06/14/16

SQL Column:

Java Field: sidPassword

Status: Active

SQL Type:

Java Type: String

Attributes: Transient

Submission Number

Added On: 02/13/12

SQL Column: SUBMISSION_NUMBER

Java Field: submissionNumber

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

First Data’s Submission number populated by First Data in output.
Leave blank on incoming submission

Token Type

Added On: 06/14/16

SQL Column: TOKEN_TYPE

Java Field: tokenType

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Total Amount

Added On: 02/13/12

SQL Column: TOTAL_AMOUNT

Java Field: totalAmount

Status: Active

SQL Type: varchar(14)

Java Type: String

Attributes:

Total amount of all detail records in this batch, which contains an
amount of transaction (echoed back from Input Record).

TPP ID

Added On: 02/13/12

SQL Column: TPP_ID

Java Field: tppId

Status: Active

SQL Type: varchar(6)

Java Type: String

Attributes:

Third Party Processor (TPP) ID First Data value assigned to the Third Party Processor.

If First Data has provided the Third Party Processor with a Third Party Processor (TPP) ID, this record should be sent at the beginning of the batch. This record will apply to all records that follow it. To reset (or remove) the TPP ID, a new TPP record would be sent that is blank filled.

This record should only be sent if you are a Third Party Processor and First Data has assigned you a TPP ID to be used with your merchants.

Unique File Id

Added On: 03/23/18

SQL Column: UNIQUE_FILE_ID

Java Field: uniqueFileId

Status: Active

SQL Type: varchar(32)

Java Type: String

Attributes: