Menu

Retrieving Available Reports

Using the API, you can retrieve a list of reports that are generated and available for download. The request format is:
https://<url_prefix>/reporting/v3/reports?startTime={startTime}&endTime={endTime}?timeQueryType={timeQueryType}
Create/Update Report Subscription Request Body 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
<
startTime
>
Report start date to search on in ISO 8601 format.
Example
: 2016-11-22T12:00:00.000Z
Required
<
endTime
>
Report end date to search on in ISO 8601 format.
Example
: 2016-11-22T12:00:00.000Z
Required
<
timeQueryType
>
Time you would like to search. Valid values:
  • reportTimeFrame
  • executedTime
Required
<
reportMimeType
>
Format of the report. Valid values are:
  • application/xml
  • text/csv
Optional
<
reportFrequency
>
Frequency of the report subscription. The options are:
  • Daily
  • Weekly
  • Monthly
  • Adhoc
Optional
<
reportName
>
Unique name of the report.
Optional
<
reportDefinitionId
>
Report definition ID.
Optional
<
reportStatus
>
Status of the report. The options are:
  • COMPLETED
  • PENDING
  • QUEUED
  • RUNNING
  • ERROR
  • NO_DATA
Optional

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