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
Acceptvalue to either
Format the URL as follows:
Name of the server from which to download the report. Use one of these values:
Report start date to search on in ISO 8601 format.
Report end date to search on in ISO 8601 format.
The organization ID under which the report is subscribed. This can be the merchant ID, account ID, or reseller ID.
Payment subtypes. The default value is
ALL. Valid values:
View results by request date or submission date. The default value is
requestDate. Valid values:
Group name, which is defined in the Group Management Module in the Business Center.
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:
Note: If an offset larger than the number of results is provided, this will result in no embedded object being returned.
Controls the maximum number of items that may be returned for a single request. The default is 2000.
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.