Search

Transaction Status File Download

A file describing the status of multiple transactions can be retrieved either programmatically or by manually retrieving the file on the Merchant Center website. The file is generated automatically at the time of the request using the data available at that moment.

This section focuses on downloading status files programmatically

You can download a Status file full of Transactions, or Authorizations. In the Authorize Status File Download there is one extra parameter, the ApprovalCode. The ApprovalCode is used for the Funds Verification result information.

File format

Status files may be retrieved in either CSV (Comma-Separated Values) for XML format. In both formats, the transactions may appear in any order.

Endpoints

URL	Endpoint
/EpnPublic/FileDownload.aspx	CGI
/EpnPublic/FileDownloadAuth.aspx	CGI

CGI Parameters

Element Name	Type	Max. Chars.	Required	Notes
UserID	String	16	Yes	Normally this is the merchant's 6-digit Company Number.
Password	String	16	Yes
Format	String	3	Yes	"TXT" for CSV format, or "XML" for XML format.
Delimiter	String	16		Either "Comma" (default), "Semicolon", or "Pipe". Ignored when Format=XML.
Incremental	Boolean	5	Yes	"True" to retrieve only transactions that are new or that have changed status since the date of the previous "Incremental" download. Transactions that haven't changed since before that date will be omitted. "False" to retrieve any transactions regardless of whether they were retrieved previously.
DateFrom	Date	10		1Earliest date for which to retrieve transactions, in the format "M/D/YYYY".
DateTill	Date	10		1Latest date for which to retrieve transactions, in the format "M/D/YYYY".
DateToCompare	String	50		Indicates which date to compare with DateFrom and DateTill parameters. May be "DateProcessed" or "EffectiveEntryDate". If no value is passed in, then DateProcessed, DateSettled, and ReturnDate are all queried.
ReturnsOnly	Boolean	5		2"True" to retrieve only Returns and BO Exceptions. "False" (default) to retrieve transactions of any status.
ShortResponse	Boolean	5		"True" to omit unused and unavailable elements from the XML. "False" to always include empty elements in the XML. Ignored when Format=TXT.
BatchID	String	10		Specify a Batch Upload ID to download only transactions uploaded in a specific batch. This may be used in combination with any of the above parameters.
Version	String	8		Specify a Version number. (example: 1.4.2.38)

The total date range you can specify is 10 days total. If you pass in a larger range, it will be adjusted to be only 10 days.

Status File Fields

Field or XML Element Name	Type	Max. Chars.	Notes
CompanyID	Int32	6	Merchant's 6-digit Company Number.
ResponseType	String	20	Current status of the transaction. Transaction Status Codes
TransID	Int32	8	Number assigned by Check Commerce to the transaction.
BillerName	String	16	Unused.
ServiceName	Int32	3	Unused.
ExternalClientID	String	40	ReferenceNumber: Identifier assigned by merchant to the transaction.
BankAccountName	String	22	Consumer's full name, first name first, last name last, with no commas.
ExtTransID	String	10	Batch Upload File Identifier
ResponseDate	Date	10	Date on which the transaction was Returned by the bank, in the format "MM/DD/YYYY".
EED	Date	10	Effective Entry Date, in the format "MM/DD/YYYY".
TransmitTime	Time	8	Unused.
EnteredBy	String	10	Unused.
TransType	String	1	D = Debit, C = Credit.
Amount	Decimal	9	U.S. Dollars.
EntryDescription	String	10	A Check Commerce code explaining why the transaction got a "B.O.Exception". Back Office Exception Codes A Transaction can have multiple BO Exceptions and they will be space separated if this occurs.
ItemDescription	String	10	Unused.
TRN	Int32	9	Bank routing number. Always 9 digits.
DDA	Int64	17	Unused.
CheckNumber	Int32	8
ResponseCode	String	3	Return Reason Code: explains why the transaction was returned. ACH Return Reason Codes
AddInfo	String	200	NOC (Notification Of Change) details. ACH Return Reason Codes
ApprovalCode	String	20	This is an optional field present in the Authorization file. It contains the Funds Confirmation information.

For plain text:

There will be 1 transaction per line. Lines will be terminated by CR/LF (DOS style) linefeeds.
Each line consists of the 21 fields described above, delimited by commas , or semicolons ; or pipes | as desired.
All 21 fields will be delimited even when they are blank, so each line will always contain exactly 20 delimiters.
There will be no extraneous white space nor quotation marks.
Although the fields are not labeled in any way, they will appear in the order given by the above table.

For XML:

The root element is <ResponseFile>.
Inside the root element is a <Transactions> element.
Inside the <Transactions> element are one or more <Transaction> elements.
Inside each <Transaction> element are elements described in the above table, which may appear in any order. The data for each element will lie between the begin and end tags.
Note that many elements may be blank or absent if they are unused or unavailable.

Information about transaction status codes can be found here Status Codes

Request Samples

a) Plain Text

Query Parameters

/EPNPublic/FileDownload.aspx?UserID={MerchantNumber}&Password={MerchantPassword}&Format=Txt&Incremental=True&Delimiter=Comma

CSV Response

501791,Processed,1904885737,,,2024041901,John Smith,4018100084,,,,,D,10,,,888888884,,,,

b) XML

Query Parameters

/EPNPublic/FileDownload.aspx?UserID={MerchantNumber}&Password={MerchantPassword}&Format=XML&Incremental=True&Delimiter=Comma

XML Response

<?xml version="1.0"?>
<ResponseFile>
    <Transactions>
        <Transaction>
            <CompanyID>{MerchantNumber}</CompanyID>
            <ResponseType>Processed</ResponseType>
            <TransID>1904885737</TransID>
            <BillerName/>
            <ServiceType/>
            <ExternalClientID>2024041901</ExternalClientID>
            <BankAccountName>John Smith</BankAccountName>
            <ExtTransID>4018100084</ExtTransID>
            <ResponseDate/>
            <EED/>
            <TransmitTime/>
            <EnteredBy/>
            <TransType>D</TransType>
            <Amount>10</Amount>
            <EntryDescription/>
            <ItemDescription/>
            <TRN>888888884</TRN>
            <DDA/>
            <CheckNumber></CheckNumber>
            <ResponseCode/>
            <AddInfo/>
        </Transaction>
    </Transactions>
</ResponseFile>