Transaction Request Report

The Transaction Request Report (previously called the Batch File Detail Report) provides detailed information about the transactions that are batched when you filter by the Batch Upload connection method. See the Business Center Reporting User Guide (PDF | HTML)for information about creating and downloading this report.

XML Format

Elements

The <Report> element is the root element of the report.

<Report Name=CDATA

Version=NMTOKEN

xmlns=CDATA

MerchantID=CDATA

ReportStartDate=CDATA

ReportEndDate=CDATA>

(BatchFiles)

</Report>

Table 8Attributes of <Report>
Attribute Name	Description	Data Type & Length
Name	Name of the report. This element always contains the text Batch Files Detail Report.	Alphanumeric (100)
Version	Version number of the report. The current version number is 1.0.	Numeric (10)
xmlns	XML namespace for the report. The namespace for the current version is http://reports.cybersource.com/reports /bfdr/1.0. For transactions in India, http://reports.in.cybersource.com/reports/bfdr/1.0.	Alphanumeric (100)
MerchantID	Cybersource merchant ID used for the transactions in the report.	Alphanumeric (30)
ReportStartDate	First date included in the report.	DateTime (25)
ReportEndDate	Last date included in the report.	DateTime (25)

Table 9Child Elements of <Report>
Element Name	Description
<BatchFiles>	Batch files that are included in the report. See <BatchFiles>, for a list of child elements.

Example <Report> Element

<Report Name="Batch Files Detail Report"

Version="1.0"

xmlns="http://reports.cybersource.com/reports/bfdr/1.0"

MerchantID="pcpawnshop"

ReportStartDate="2006-09-29T05:00:00-05:00"

ReportEndDate="2006-09-30T05:00:00-05:00">

...

</BatchFiles>

</Report>

The <BatchFiles> element contains all of the batch files that are included in the report.

(BatchFile)*

</BatchFiles>

Table 10Child Elements of <BatchFiles>
Element Name	Description
<BatchFile>	Payment processors for the transactions in the batch file. See <BatchFile>, for a list of attributes and child elements.

Example <BatchFiles> Element

...

</BatchFile>

</BatchFiles>

The <BatchFile> element contains the payment processors for the transactions in the batch file.

(PaymentProcessor)*

</BatchFile>

Table 11Attributes of <BatchFile>
Attribute Name	Description	Data Type & Length
BatchFileID	Cybersource batch file in which the transactions were sent.	Numeric (39)

Table 12Child Elements of <BatchFile>
Element Name	Description
<PaymentProcessor>	Requests associated with the payment processor. See <PaymentProcessor>, for a list of attributes and child elements.

Example <BatchFile> Element

...

</PaymentProcessor>

</BatchFile>

The <PaymentProcessor> element contains the requests associated with a payment processor.

(Request)*

</PaymentProcessor>

Table 13Attributes of <PaymentProcessor>
Attribute Name	Description	Data Type & Length
PaymentProcessorName	Name of a payment processor.	Alphanumeric (30)

Table 14Child Elements of <PaymentProcessor>
Element Name	Description
<Request>	Information about a payment transaction. See <Request>, for a list of attributes.

Example <PaymentProcessor> Element

...

</Request>

</PaymentProcessor>

The <Request> element contains information about a payment transaction.

(TransactionReferenceNumber)

(MerchantReferenceNumber)

(TransactionStatus)

(Amount)

(CurrencyCode)

(PaymentStatus)

</Request>

Table 15Attributes of <Request>
Attribute Name	Description	Data Type & Length
RequestID	Unique identifier generated by Cybersource for the transaction.	Numeric (26)

Table 16Child Elements of <Request>
Element Name	Description	Data Type & Length
Transaction Reference Number	Reference number that you use to reconcile your Cybersource reports with your processor reports. This field corresponds to the <service>_reconciliationID (Simple Order API) and to the <service>_trans_ref_no (SCMP API) reply fields.	Alphanumeric (60)
Merchant Reference Number	Merchant-generated order reference or tracking number.	Alphanumeric (50)
Transaction Status	One-word description of the result of the transaction request.	Alphanumeric (50)
Amount	Amount of the transaction.	Amount (19)
CurrencyCode	ISO currency code used for the transaction.	Alphanumeric (5)
PaymentStatus	One-word description of the current status of the transaction. Possible values: nBATCH_ERROR nBATCH_RESET nBATCHED nCANCELED_REVERS nCANCELLED nDENIED nFAILED nPENDING nREFUNDED nREVERSED nTRXN_ERROR nVOIDED	Alphanumeric (50)

Example <Request> Element

<PaymentStatus>PENDING</PaymentStatus>

</Request>

DTD

<!ELEMENT Report (BatchFiles)>

<!ATTLIST Report Name CDATA #REQUIRED

Version NMTOKEN #REQUIRED

xmlns CDATA #REQUIRED

MerchantID CDATA #REQUIRED

ReportStartDate CDATA #REQUIRED

ReportEndDate CDATA #REQUIRED>

<!ELEMENT BatchFiles (BatchFile)*>

<!ELEMENT BatchFile (PaymentProcessor)*>

<!ATTLIST BatchFile BatchFileID CDATA #REQUIRED>

<!ELEMENT PaymentProcessor (Request)*>

<!ATTLIST PaymentProcessor PaymentProcessorName CDATA #REQUIRED>

<!ELEMENT Request (TransactionReferenceNumber, MerchantReferenceNumber,

TransactionStatus, Amount, CurrencyCode, PaymentStatus)>

<!ATTLIST Request RequestID CDATA #REQUIRED>

<!ELEMENT TransactionReferenceNumber (#PCDATA)>

<!ELEMENT MerchantReferenceNumber (#PCDATA)>

<!ELEMENT TransactionStatus (#PCDATA)>

<!ELEMENT Amount (#PCDATA)>

<!ELEMENT CurrencyCode (#PCDATA)>

<!ELEMENT PaymentStatus (#PCDATA)>

Example

The following example shows a report that contains two batch files. The first batch file contains three requests, and the second batch file contains one request.

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Report SYSTEM "https://ebctest.cybersource.com/ebctest/reports/dtd/bfdr.dtd">

<Report Name="Batch Files Detail Report"

Version="1.0"

xmlns="https://ebctest.cybersource.com/ebctest/reports/dtd/bfdr.dtd"

MerchantID="pcpawnshop"

ReportStartDate="2006-09-29T05:00:00-05:00"

ReportEndDate="2006-09-30T05:00:00-05:00">

<PaymentStatus>PENDING</PaymentStatus>

</Request>

<PaymentStatus>PENDING</PaymentStatus>

</Request>

<PaymentStatus>VOIDED</PaymentStatus>

</Request>

</PaymentProcessor>

</BatchFile>

<PaymentStatus>PENDING</PaymentStatus>

</Request>

</PaymentProcessor>

</BatchFile>

</BatchFiles>

</Report>

CSV Format

Records

First Header Record

The first header record describes the name and version of the report and indicates which dates are included in the report.

Example First Header Record

Batch Files Detail Report,1,2006-09-29 to 2006-09-30,,,,,,,

Table 17Fields in the First Header Record
Position	Field Name	Description	Data Type & Length
1 (A)	report_name	Name of the report. This field always contains the text Batch Files Detail Report.	Alphanumeric (100)
2 (B)	version_number	Version number of the report. The current version number is 1.	Numeric (10)
3 (C)	date_range	Dates included in the report in the format YYYY-MM-DD to YYYY-MM-DD. The first date is the start date; the second date is the end date.	Alphanumeric (100)

Second Header Record

The second header record indicates the name of each field in the report. The fields in the second header record follow these rules:

nThe content of each field is the same as the field name.

nThe data type and length of each field is alphanumeric (100).

Example Second Header Record

merchant_id,txn_batch_id,payment_processor,request_id,trans_ref_no,merchant_ref_number,ics_rflag,amount,currency,action

Transaction Record

Each transaction record contains information about a Cybersource payment transaction.

Example Transaction Record

pcpawnshop,127788,vital,9979040000003515181891,7242635150,1158078228539,SOK,25.00,USD,PENDING

Table 18Fields in the Transaction Record
Position	Field Name	Description	Data Type & Length
1	merchant_id	Cybersource merchant ID used for the transaction.	Alphanumeric (30)
2	txn_batch_id	Cybersource batch file in which the transactions were sent.	Numeric (39)
3	payment_ processor	Name of a payment processor.	Alphanumeric (30)
4	request_id	Identifier for the transaction.	Numeric (26)
5	trans_ref_no	Reference number that you use to reconcile your Cybersource reports with your processor reports. This field corresponds to the <service>_reconciliationID (Simple Order API) and to the <service>_trans_ref_no (SCMP API) reply fields.	Alphanumeric (60)
6	merchant_ref_ number	Merchant-generated order reference or tracking number.	Alphanumeric (50)
7	ics_rflag	One-word description of the result of the transaction request.	Alphanumeric (50)
8	amount	Amount of the transaction.	Amount (19)
9	currency	ISO currency code used for the transaction.	Alphanumeric (5)
10	action	One-word description of the current status of the transaction. Possible values: nBATCH_ERROR nBATCH_RESET nBATCHED nCANCELED_REVERS nCANCELLED nDENIED nFAILED nPENDING nREFUNDED nREVERSED nTRXN_ERROR nVOIDED	Alphanumeric (50)

Example

The following example shows a report that contains two batch files. The first batch file contains three requests, and the second batch file contains one request.

Batch Files Detail Report,1,2006-09-29 to 2006-09-30,,,,,,,

merchant_id,txn_batch_id,payment_processor,request_id,trans_ref_no,
merchant_ref_number,ics_rflag,amount,currency,action

pcpawnshop,127788,vital,1598344253232243215,7242635150,1158078228539,SOK,25.00,USD,PENDING

pcpawnshop,127788,vital,1598354743232243226,7242636613,1158078892610,SOK,100.00,USD,PENDING

pcpawnshop,127788,vital,1598364563232243237,7242637653,1158079157035,SOK,99.00,USD,VOIDED

pcpawnshop,123987,smartfdc,1594779663232243248,7243278653,1159429157035,SOK,4.00,USD,PENDING