Menu

Downloading Payment Batch Summary Report

The Payment Batch Summary report shows total sales and refunds by currency and payment method. To request the report, your client application must send an HTTP GET message to the report server. Format the URL as follows:
https://
<url_prefix>/reporting/v3/payment-batch-summaries&startTime={startTime}&endTime={endTime}
On-Demand Net Funding 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
Required
<
startTime
>
Report start date to search on in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
Example
: 2019-05-01T12:00:00-05:00
Required
<
endTime
>
Report end date to search on in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
Example
: 2019-08-30T12:00:00-05:00
Required
<
organizationId
>
The organization ID under which the report is subscribed. This can be the merchant ID, account ID, or reseller ID.
Optional
<
rollUp
>
Specifies whether to present data in spans of a single day, week, or month. The options are:
  • day
  • week
  • month
Conditional. Required when requesting breakdown data for a merchant.
<
breakdown
>
Used to request data at the parent-level account, such as Reseller. The options are:
  • account_rollup
    : Returns batch summaries data aggregated at the account level.
  • all_merchant
    : Returns batch summaries data for all MIDs that belong to the requesting parent ID.
  • selected_merchant
    : Returns batch summaries data for the selected merchant.
Conditional. Required when requesting breakdown data for a merchant.
<
startDayOfWeek
>
Start day of week to breakdown data. The options are:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
Optional

Responses

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