Back

Batch File Attributes

Along with the four-part key, the XML Batch file format uses additional attributes.

NOTE: With these additional attributes, it is important to note that when creating a batch file, the BATCH_ID is used as an attribute rather than as a field element when it is used for real-time processing.

The table below provides the definitions for the additional attributes; the text below the table provides examples of their use.

Additional Attributes for Batch Files

Attribute	Description
file_id	The file_id attribute is a field that is identical to the value of the file_id that is part of the file name for the current batch file. See the Batch Processing API guide for more information on the file_id and file naming convention.
file_total_amount	The file_total_amount attribute contains the sum of all transaction amounts within the batch file.
file_tran_count	The file_tran_count attribute contains the total number of transactions within the batch file.
batch_total_amount	The batch_total_amount attribute contains the sum of all transaction amounts within the batch_id within the file.
batch_tran_count	The batch_tran_count attribute contains the total number of transactions within the batch_id within the file.

Batch XML Example


    <FILE FILE_ID=”20210901A" FILE_TOTAL_AMOUNT="150.00" FILE_TRAN_ COUNT="28">
    <BATCH CUST_NBR="1234" MERCH_NBR="1234567" DBA_NBR="1" TERMINAL_ NBR="1"
    BATCH_ID="202109011" BATCH_TRAN_COUNT="20" BATCH_TOTAL_ AMOUNT="126.00">
    …
    </BATCH>
    <BATCH CUST_NBR="1234" MERCH_NBR="7654321" DBA_NBR="1" TERMINAL_ NBR="1"
    BATCH_ID="202109012" BATCH_TRAN_COUNT="8" BATCH_TOTAL_ AMOUNT="24.00">
    …
    </BATCH>
    </FILE>

Detail Element

The DETAIL Element of your transaction request will have many child elements that make up the fields needed to process transactions on the EPX payment gateway. The fields required for each transaction are dependent upon which transaction type (TRAN_TYPE) you would like to use. Refer to your Transaction Specifications document to view a list of mandatory and optional fields to use with the transactions in your industry type.

Field Definitions

The following sections contain a complete list of available fields and descriptions for use in the EPX payment gateway. Refer to your Transaction Specifications document to view a list of mandatory and optional fields associated with the transactions you use.

Transaction Request Fields
Transaction Response Fields
EPX Hosted Pay Page Request Fields
Browser Post Validation Response Fields
Verified by Visa and MasterCard SecureCode Request Fields