Menu

Viewing Report Definitions

You can view a list of supported reports and their attributes before subscribing to them. You can also view the attributes of an individual report type.
For a summary of all reports, the request format is:
GET https://<
url_prefix>/reporting/v3/report-definitions?organizationId={organizationId
}
Summary Report Definition 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
For a summary of a single report type, the request format is:
GET https://<
url_prefix>/reporting/v3/report-definitions/{reportDefinitionName}?organizationId={organizationId}&download=true
Single Report Definition 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
<
reportDefinitionName
>
Name of the report type you want to review. The options are:
  • TransactionRequestClass
    : Transaction Request Report
  • PaymentBatchDetailClass
    : Payment Batch Detail Report
  • ExceptionDetailClass
    : Transaction Exception Detail Report
  • ProcessorSettlementDetailClass
    : Processor Settlement Detail Report
  • ProcessorEventsDetailClass
    : Processor Events Detail Report
  • FundingDetailClass
    : Funding Detail Report
  • AgingDetailClass
    : Aging Detail Report
  • ChargebackAndRetrievalDetailClass
    : Chargeback And Retrieval Detail Report
  • DepositDetailClass
    : Deposit Detail Report
  • FeeDetailClass
    : Fee Detail Report
  • InvoiceSummaryClass
    : Invoice Summary Report
  • PayerAuthDetailClass
    : Payer Authentication Detail Report
  • ConversionDetailClass
    : Conversion Detail Report
  • SubscriptionDetailClass
    : Subscription Detail Report
  • JPTransactionDetailClass
    : JP Transaction Detail Report
  • ServiceFeeDetailClass
    : Service Fee Detail Report
  • GatewayTransactionRequestClass
    : Gateway Transaction Request Report
  • DecisionManagerEventDetailClass
    :
    Decision Manager
    Event Detail Report
  • RecurringBillingDetailClass
    : Recurring Billing Details Report
Required
<
organizationId
>
The organization ID under which the report is subscribed. This can be the merchant ID, account ID, or reseller ID.
Optional

Responses

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