Search documentation:
	Help  Advanced
Published 05/13/2002

Chapter 1

Downloading CyberSource Reports

This chapter explains how you can implement a client application to download CyberSource reports.

Overview

The reporting system enables you to download two reports:

• Payment Batch Detail Report

This report contains information about credit card and electronic check transactions.

• Transaction Detail Report

This report contains summary information about your transactions. It also includes detailed information about your payment and Advanced Fraud Screen transactions.

Each report is available in the following formats:

• Extensible Markup Language (XML)

You can use XML-compliant tools to process these reports.

• Comma-separated values (CSV)

These reports are similar to the old reporting system's pipe-delimited or tab-delimited reports.

Note  The CSV version of the Transaction Detail Report does not include information about the offers in a transaction. If you need this information, you must use the XML version of the report.

To download reports, you implement a client application that uses Hypertext Transfer Protocol Secure (HTTPS) to connect to the reporting server. You can also use the information in this guide to write applications that process these reports automatically.

Each report shows your transactions for a single day. If you want to view information for an entire week, month, or year, you must combine the daily reports.

Client Application Requirements

To connect to the report server, your client application must support HTTPS connections. An HTTPS connection is like an HTTP connection, but it is encrypted using Secure Sockets Layer (SSL).

Your client application must support HTTP/1.0 or HTTP/1.1 connections. In addition, your client application must support SSL v2 or SSL v3 connections.

HTTPS libraries are available for many programming languages, including Java, C/C++, Perl, and Visual Basic. You can implement a client in any language that allows you to use HTTPS to communicate with the report server.

Note  You may be able to use a third-party client application to download CyberSource reports. However, CyberSource cannot recommend or support any third-party client applications or client libraries.

Request Format

To request a report, your client application must send an HTTP GET message to the report server. The URL that you specify in your message indicates which report you want to download.

Use the following format for the URL:

https://<server_name>/reports/servlet/DownloadReport/YYYY/MM/DD/<merchant_ID>/<report_name>.<report_format>

For example, if your merchant ID is sample, you would use the following URL to download the XML version of the February 1, 2002 Transaction Detail Report from the production system:

https://downloadreports.cybersource.com/reports/servlet/DownloadReport/2002/02/01/sample/TransactionDetailReport.xml

Important  If you have not subscribed to a report, it will not be generated for you, and you will not be able to download it. Each report can be created in either CSV or XML format; you cannot receive a single report in both formats. Use the reporting Web site to subscribe to reports.

The following table describes each value in the URL.

Table 1 Report URL Values 

Value	Description
<server_name>	Name of the server from which to download the report. Use one of the following values: downloadreportstest.cybersource.com: Test server. downloadreports.cybersource.com: Production server.
YYYY	Four-digit year.
MM	Two-digit month. For example, use 02 for February.
DD	Two-digit day. For example, use 01 for the first day of the month.
<merchant_id>	CyberSource merchant ID.
<report_name>	Name of the report to download. Use one of the following values: PaymentBatchDetailReport TransactionDetailReport
<report_format>	Report format to download. Use one of the following values: csv: Comma-separated values. xml: Extensible Markup Language.

User Authentication

When you download a report, you must provide a user name and password. Use the same user name and password that you use with the reporting Web site.

Note  You cannot use an administrator account to download reports. For information about administrator accounts, see the CyberSource Reporting User's Guide, available on the CyberSource Support Center.

Your client application must use Basic Access Authentication to send the user name and password. Many HTTPS client libraries implement this authentication method. For information about Basic Access Authentication, see http://www.ietf.org/rfc/rfc2617.txt.

Reply Format

If the request is successful, the server responds by sending an HTTPS reply message. The body of this message contains the report that you requested. The report is in either XML or CSV format, depending on how you configure your reports.

Note  You cannot receive a report in both formats.

For information about report formats, see Chapter 2, "XML Report Formats" and Chapter 3, "CSV Report Formats". For information about configuring your reports, see the CyberSource Reporting User's Guide, available on the CyberSource Support Center.

If the request fails, the server sends an HTTP reply message that describes the error. Use this information to determine why the request failed and to debug your client application.