Menu

Downloading On-Demand Purchase and Refund Detail Report

The Purchase and Refund Detail Report contains purchase and refund details that have been submitted to your payment processor. Merchants using certain payment processors will also see fee and funding data. To request the report, your client application must send an HTTP GET message to the report server. The default format for responses is JSON, but some reports can also return CSV or XML. You can set the response to return CSV or XML in the request header by setting the
Accept
value to either
application/xml
or
text/csv
.
Format the URL as follows:
https://
<url_prefix>/reporting/v3/purchase-refund-details&startTime={startTime}&endTime={endTime}
On-Demand Purchase and Refund Detail Report 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
<
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
<
organizationId
>
The organization ID under which the report is subscribed. This can be the merchant ID, account ID, or reseller ID.
Optional
<
paymentSubtype
>
Payment subtypes. The default value is
ALL
. Valid values:
  • ALL: All Payment Subtypes
  • VI: Visa
  • MC: Mastercard
  • AX: American Express
  • DI: Discover
  • DP: PINless Debit
Optional
<
viewBy
>
View results by request date or submission date. The default value is
requestDate
. Valid values:
  • requestDate: Request Date
  • submissionDate: Submission Date
Optional
<
groupName
>
Group name, which is defined in the Group Management Module in the Business Center.
Optional
<
offset
>
Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset.
For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value:
offset=0
,
offset=5
, and
offset=10
.
Note
: If an offset larger than the number of results is provided, this will result in no embedded object being returned.
Optional
<
limit
>
Controls the maximum number of items that may be returned for a single request. The default is 2000.
Optional

Responses

This call can return one of the following HTTP status codes:
  • 200: Ok.
  • 400: Invalid request.
  • 401: Unauthorized. The provided token is no longer valid.
  • 404: Report not found or no transactions are available.
  • 500: Internal server error.
For detailed information on the responses, including which fields are returned, see the Reporting REST API Reference.
Back to top