Menu

Creating a One-Time Report

To create a one-time report, your client application must send an HTTP POST request to the report server. The request body contains the details for creating the report, such as the report type, the start time, and the frequency. The format of the URL is as follows:
PUT https://<url_prefix>/reporting/v3/reports
The request body would be:
{ "organizationId": "myorg", "reportName": "DailyTransactions", "reportDefinitionName": "TransactionDetailClass", "reportFields": [ "Request.RequestID", "Request.TransactionDate", "Request.MerchantID", "BillTo.FirstName", "BillTo.LastName", "BillTo.City",], "startTime": "1100", "reportMimeType": "application/xml, "reportFrequency": "DAILY", "timezone": "GMT", "startTime": "0900", "startDay": "1" }
Create One-Time Report URL Values
Value
Description
<
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
Create/Update Report Subscription Request Body Values
Value
Description
Required/ Optional
<
organizationId
>
The organization ID under which the report is subscribed. This can be the merchant ID, account ID, or reseller ID.
Optional
<
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
<
reportFields
>
Array of field names which should be included in the report. For a list of available fields, see Reporting Fields and Descriptions
Required
<
reportMimeType
>
Format of the report. Valid values are:
  • application/xml
  • text/csv
Optional
<
reportName
>
Unique name of the report subscription you want to create or edit.
Required
<
timeZone
>
Merchant’s time zone.
Example
: America/Chicago
Optional
<
startTime
>
Time of day the report will run.
Format
: HHMM
Optional
<
startDay
>
Day of month (1-31) the report will run for monthly reports.
Optional
<
reportFilters
>
Array that contains additional filters.
Optional
<
reportPreferences.signed Amounts
>
Indicator that determines whether or not a negative sign is used for the amount of all refunded transactions. Valid values:
  • true
  • false
Optional
<
reportPreferences.fieldName Convention
>
Specify the field naming convention to be followed in reports (applicable only to csv report formats). Valid values:
  • SOAPI
  • SCMP
Optional
<
selectedMerchantGroupName
>
Name of the merchant group.
Optional

Responses

This call can return one of the following HTTP status codes:
  • 200: Ok.
  • 304: Not modified.
  • 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