Downloading Merchant Account Reports
This chapter covers downloading the following reports via a query API or requesting reports using a client application.
Requesting a Report with a Client Application
To connect to the report server, your client application must support HTTPS connections. Your client application must support HTTP/1.0 or HTTP/1.1 and TLS 1.0, 1.1 or 1.2 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.
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
.
To send an API request with an HTML form or any script, you need this URL:
https://ebc.cybersource.com/ebc/DownloadAcquiringReports
HTML Format
To use the HTML format, you write an HTML form with the same URL as below. The sample below shows the form tag with the action to send a report request to the production URL. The form includes the required fields and a Submit button.
■
Production URL:
https://ebc.cybersource.com/ebc/DownloadAcquiringReports
■
Test URL:
https://ebctest.cybersource.com/ebctest/DownloadAcquiringReports
If you use an HTML form to request a report, the form will look similar to the example below.
<html>
<head>
<title></title>
</head>
<body>
<form method="post" action="https://ebc.cybersource.com/ebc/DownloadAcquiringReports" name="PaymentActivitySummaryForm">
<table>
<tbody>
<tr>
<td>nodeValue</td>
<td><input name="nodeValue" value="101010101001" type="text"></td>
</tr>
<tr>
<td>startDate</td>
<td><input name="startDate" value="04/01/2008" type="text"></td>
</tr>
<tr>
<td>endDate</td>
<td><input name="endDate" value="05/01/2008" type="text"></td>
</tr>
<tr>
<td>organizationId</td>
<td><input name="organizationId" value="rsmerchant_acct" type="text"></td>
</tr>
<tr>
<td>reportId</td>
<td><input name="reportId" value="74" type="text"></td>
</tr>
<tr>
<td>format</td>
<td><input name="format" value="xml" type="text"></td>
</tr>
</tbody>
</table>
<input type="submit">
</form>
</body>
</html>
When you post this form to the download URL, you first authenticate with your username and password. After successful authentication and authorization of the report contents based on user credentials and the parameters, the report streams back to you in the requested format.
Java Stand-Alone Application
You can also write scripts or small programs to download these reports. The sample shows a Java stand-alone application that downloads the report in the requested format.
public static void downloadReport(String urlStr, String Name,String Password,String data,String filePath) throws Exception{
// Send data
URL url = new URL(urlStr);
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
conn.setRequestProperty("Authorization", "Basic " + encode(Name + ":" + Password));
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();
// Get the response
DataInputStream rd = new DataInputStream(conn.getInputStream());
FileOutputStream fos = new FileOutputStream(filePath);
int bytesRead = -1;
byte[] b = new byte[32];
while ((bytesRead = rd.read(b)) != -1) {
fos.write(b, 0, bytesRead);
}
wr.close();
rd.close();
fos.close();
}