Menu

Downloading Reports

You can use Reporting API to download completed reports. For information about creating reports, see the
Business Center Reporting User Guide
. You cannot receive a report in more than one format.

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. Format the URL as follows:
https://
<url_prefix>/reporting/v3/report-downloads&organizationId={organizationId}&reportDate={date}&reportName={reportName}
For example, if your organization ID were
SampleMerchant
, you would use the following URL to download the XML version of the February 20, 2017, which is named Sample Daily Report:
https://
<url_prefix>/reporting/v3/report-downloads&organizationId=SampleMerchant&reportDate=20170220&reportName=SampleDailyReport
Report Download URL Values
Value
Description
Required/ Optional
<
url_prefix
>
Name of the server from which to download the report. Use one of these values:
  • Production
    : api.cybersource.com
  • Production in India
    : api.in.cybersource.com
  • Test
    : apitest.cybersource.com
  • Production
    : api.merchant-services.bankofamerica.com
  • Test
    : apitest.merchant-services.bankofamerica.com
Required
<
organizationId
>
The organization ID under which the report is subscribed. This can be the merchant ID, account ID, or reseller ID.
Optional
<
reportName
>
Unique name of the report subscription you want to create or edit.
Required
<
reportDate
>
The date of the report. For reports that span multiple days, this value would be the end date of the report.
Format
: YYYYMMDD
Required
You can also download reports based on the report ID. To find out the report ID for a report, perform a report search as described in Retrieving Available Reports and find the report ID value you want to search for in the response. Format the URL as follows:
https://
<url_prefix>/reporting/v3/reports/{reportId}&organizationId={organizationId}
Report Download by Report ID URL Values
Value
Description
<
url_prefix
>
Name of the server from which to download the report. Use one of these values:
  • Production
    : api.cybersource.com
  • Production in India
    : api.in.cybersource.com
  • Test
    : apitest.cybersource.com
  • Production
    : api.merchant-services.bankofamerica.com
  • Test
    : apitest.merchant-services.bankofamerica.com
<
reportId
>
Report ID.
<
organizationId
>
The organization ID under which the report is subscribed. This can be the merchant ID, account ID, or reseller ID.

Responses

This call can return one of the following HTTP status codes:
  • 200: Ok.
  • 400: Invalid request.
  • 404: Report not found or there are no available transactions.
For detailed information on the responses, including which fields are returned, see the Reporting REST API Reference.
Back to top