Custom Report Concepts

This section introduces concepts that will help you create reports to best suit your needs. See "Creating a Report," page 17, for step-by-step information on creating and configuring reports.

The Custom Reports module provides two kinds of reports:

■	Recurring report subscriptions that run at a chosen interval (for example, daily)

■	One-time reports that cover a period of time in the past (for example, last month)

Both recurring and one-time reports are available for download from the New Business Center.

Recurring Report Subscriptions

A recurring report subscription is a template that describes the attributes of a report, including how often it runs and the period of time it spans. After your recurring report is generated, it is available for download on the Available Reports page. Users can create 20 report subscriptions.

The user can customize the following attributes of a recurring subscription:

■	Name—a unique name for the report. The name cannot be changed after a report is created.

■	Report type—a set of basic reports that can be customized. The report type cannot be changed after a report is created. See "Report Types," page 14, for a list of available reports.

■	Format—the format of a generated report (XML or CSV).

■	Frequency—the frequency at which a report runs: daily, weekly, or monthly. See "Frequency and Start Time," page 9, for a detailed explanation.

■	Start time—the time of day at which a report runs. See "Frequency and Start Time," page 9, for a detailed explanation.

Frequency and Start Time

Together, frequency and start time determine the contents of a report. When the report runs, it uses the start time and frequency to determine the ending time for transactions in the report. The frequency controls how often your report is generated. For example:

■

A daily report scheduled to start at 5:00 p.m. PST runs every day and contains transactions that occurred between 5:00 p.m. the previous day and 4:59 p.m. PST of the current day, every day. A daily report that runs at 5:00 p.m. on February 2 includes transactions for February 1, 5:00 p.m., through February 2, 4:59 p.m.

■

A weekly report scheduled to start at 11:00 a.m. EST on a Monday will contain transactions from the previous 7 days that occurred between 11:00 a.m. on the first day of the time period and 10:59 a.m. on the last day. A weekly report that runs at 11:00 a.m. on February 13 includes transactions for February 6, 11:00 a.m., through February 13, 10:59 a.m.

■

A monthly report scheduled to start at 6:00 a.m. PST on the 1st will contain transactions from the previous 28-31 days that occurred between 6:00 a.m. on the first day of the time period and 5:59 a.m. on the last day. A monthly report that runs at 6:00 a.m. on February 1 includes transactions for January 1, 6:00 a.m., through February 1, 5:59 a.m.

Generate Date and Time

The generate date and time varies depending on the amount of time it takes to generate the report. Recurring daily reports are generated and available for download within 6 hours of the start time. For example:

■	A daily report that spans 5:00 p.m. to 4:59 p.m. might have a generate time of 7:00 p.m.

■	A daily report that spans 11:00 p.m. to 10:59 p.m. might have a generate time of 1:00 a.m. the following day.

The exact amount of time that is needed to generate a recurring daily report varies based on the size of the report and the load on the system.

Auto-Subscribed Reports

Newly boarded merchants are automatically subscribed to the following reports:

■	Transaction Request Report

■	Payment Batch Detail Report

■	Transaction Exception Detail Report

■	Processor Events Report

■	Invoice Summary Report

The tables below list the fields that are included by default for these auto-subscribed reports.

The fields included by default for auto-subscribed reports are different than the default fields included when you create a new custom report subscription. See Appendix B, Report Fields Available for the list of default fields.

 

Table 1

Fields Automatically Included in the Transaction Request Report

Application Fields
Name	Rcode	Rflag
Rmsg
BillTo Fields
Address1	Address2	City
CompanyName	CompanyTaxID	Country
CustomerID	Email	FirstName
HostName	IPAddress	LastName
MiddleName	NameSuffix	PersonalID
Phone	State	Title
UserName	Zip
LineItems Fields
FulfillmentType	InvoiceNumber	MerchantProductSku
Number	ProductCode	ProductName
Quantity	TaxAmount	UnitPrice
PaymentData Fields
Amount	AuthorizationCode	CurrencyCode
TransactionRefNumber
PaymentMethod Fields
AccountSuffix	BankAccountName	BankCode
BoletoBarCodeNumber	BoletoNumber	CardType
CheckNumber	ExpirationMonth	ExpirationYear
IssueNumber	MandateId	MandateType
SignatureDate	StartMonth	StartYear
WalletType
Request Fields
MerchantID	MerchantReferenceNumber	RequestID
TransactionDate

 

Table 2

Fields Automatically Included in the Payment Batch Detail Report

Batch Fields
BatchDate	BatchID
PaymentData Fields
Amount	CurrencyCode	TransactionRefNumber
Request Fields
MerchantID	MerchantReferenceNumber	RequestID
TransactionDate

 

Table 3

Fields Automatically Included in the Transaction Exception Detail Report

Application Fields
Name	Rcode	Rflag
Rmsg
Batch Fields
BatchDate	BatchID
BillTo Fields
Address1	Address2	City
CompanyName	CompanyTaxID	Country
CustomerID	Email	FirstName
HostName	IPAddress	LastName
MiddleName	NameSuffix	PersonalID
Phone	State	Title
UserName	Zip
Exception Fields
Action	ExceptionAmountCurrency	ExceptionCategory
ExceptionMessage	ExceptionType	LastsActionDate
NextActionDate	PaymentNumber	ProcessorResponseCode
ReasonCode	RetryCount
LineItems Fields
FulfillmentType	InvoiceNumber	MerchantProductSku
Number	ProductCode	ProductName
Quantity	TaxAmount	UnitPrice
PaymentData Fields
Amount	AuthorizationCode	CurrencyCode
TransactionRefNumber
PaymentMethod Fields
AccountSuffix	BankAccountName	BankCode
BoletoBarCodeNumber	BoletoNumber	CardType
CheckNumber	ExpirationMonth	ExpirationYear
IssueNumber	MandateId	MandateType
SignatureDate	StartMonth	StartYear
WalletType
Request Fields
MerchantID	MerchantReferenceNumber	RequestID
TransactionDate

 

Table 4

Fields Automatically Included in the Processor Events Detail Report

CardPresent Fields
Debit_indicator
ChargebackAndRetrieval Fields
FeeAmount	FeeCurrency
Event Fields
Amount	CurrencyCode	Event
EventDate	ProcessorMessage
PaymentData Fields
TransactionRefNumber
PaymentMethod Fields
BoletoNumber
Request Fields
MerchantID	MerchantReferenceNumber	RequestID
TransactionDate

 

Table 5

Fields Automatically Included in the Invoice Summary Report

Invoice Fields
BillingGroupDescription	NotProcessed	OrganizationID
PerformedServices	Processed	Total

These subscriptions can be deleted or modified by the merchant. See Appendix B, Report Fields Available for a full list of available fields in each report.

One-Time Reports

A one-time report runs only once, and spans a period of time in the past, and can include up to 31 days of data. For example, a one-time report can contain transactions that occurred between 5:00 p.m. on 6/1/2016 and 4:59 p.m. on 6/7/2016.

If you want to create a report covering 24 hours between midnight and midnight, then it is necessary to set the report To and From as in the following example: From: 12:00 a.m. on 1/1/2016 To: 12:00 a.m. on 1/2/2016

A one-time report might be useful when:

■	You need information about transactions that happened before you set up your recurring subscription.

■	You want to test a report before setting up a recurring subscription.

■	You need a particular type of information only one time, so a recurring subscription is unnecessary.

When you need past information that spans more than 31 days, you can create multiple one-time reports. In order to protect system performance, each user is able to generate up to three one-time reports concurrently. Additional one-time reports can be scheduled after the first three reports complete.

After your one-time report is generated, it is available for download on the Available Reports page. Depending on the size of the report, it might take longer than 6 hours to generate.

Finding a One-Time Report

By default, reports on the Available Reports page are sorted by report date range. If you created a one-time report that spans a period of time several days or more in the past, it might not appear on the first page of Available Reports. To quickly find a one-time report, filter the result set by frequency and select One Time.

While your report is generating, it is not shown on the Available Reports page. It appears on this page after the generation is complete.

Reports for Account-Level (SSO) Users

Account-level users (SSO) can create reports for themselves; the reports contain data for all of the organizations under that SSO. In addition, account-level users can view reports created by organizations under them. Account-level users cannot create reports on behalf of organizations under their account.

Report Types

You can customize reports by adding fields to those that are required in the report. The following base reports are available:

■	Gateway Reports

●	Transaction Request Report (TRR)

●	Payment Batch Detail Report (PBDR)

●	Payment Exception Detail Report

●	Invoice Summary Report

■	Merchant Account Reports

●	Processor Settlement Detail Report

●	Processor Events Detail Report

●	Funding Detail Report

●	Aging Detail Report

●	Fee Detail Report

●	Fee Summary Report

●	Chargeback and Retrieval Detail Report

●	Deposit Detail Report

Gateway Reports

■

Transaction Request Report (TRR)— all transactions that pass through the CyberSource gateway in the given interval. For example, this report might contain authorizations (ics_auth), sales and refunds (ics_auth/ics_bill, ics_sale, ics_refund), or new subscriptions (ics_subscription_create). Merchants can use this report to audit their logs and enrich their analytics data.

This report is similar to the Transaction Detail Report (TDR) found in the Classic Business Center. Both reports contain all transactions that pass through the CyberSource gateway. If you want to create a Transaction Request Report that is similar to the TDR, see "Transitioning to the New Custom Reports," page 23.

■

Payment Batch Detail Report (PBDR)—all transactions that are batched to the processor in the given interval. Merchants can use this report to monitor the batch submission process and help predict their cash flow/funding timing. The batch date and time represents the date and time that CyberSource batched the transactions to the processors.

To ensure that the report contains the most recently batched transactions, schedule this report to begin an hour or two after your daily batch end time. You can also choose to schedule multiple Payment Batch Detail Reports to suit your needs.

The report contains transactions with a batch date and time that occur within the given interval.

The ability to configure the time period covered in a daily report offers more flexibility than the current Business Center reporting. However, there are nuances to consider about your Payment Batch Detail Report. Consider the following cases. For some merchants, the batch cut-off time may occur after the end of the logical business day. For example:

●	Your logical business day begins at 9:00 a.m. PST.

●	Your logical business day ends at 6:00 p.m. PST.

●	Your batch end time is 7:00 p.m. PST.

In this situation, it would be useful to schedule the PBDR to begin at 8:00 p.m. PST so that it contains the transactions batched from the logical business day.

For other merchants, the batch cut-off time may occur within the logical business day. For example:

●	Your logical business day begins at 9:00 a.m. EST.

●	Your logical business day ends at 11:59 p.m. EST.

●	Your batch cutoff time is 9:00 p.m. EST.

In this situation, transactions from your logical business day will span two batches. Some transactions will be in the batch at 9:00 p.m., and others will be in the next day's batch. You might want to schedule your report to begin at 10:00 p.m. EST, because transactions with a batch date after 10:00 p.m. EST appear on the following day's report, because they will be in the following day's batch. You can also choose to schedule multiple Payment Batch Detail Reports to suit your needs.

For some merchants, the batch date will occur one calendar day after the transactions occur.

Sometimes a transaction request date is different from the batch date. For example:

●	May 1, 9:00 a.m. EST—a sale is authorized.

●	May 3, 9:00 p.m. EST—the sale is captured (settled).

●	May 4, 1:000 a.m. EST—CyberSource receives acknowledgment from the processor that the sale batched successfully.

In this situation, transactions that are captured on May 3 have a batch date of May 4.

This report is similar to the Payment Batch Detail Report found in the Classic Business Center. If you want to create a new Payment Batch Detail Report that is similar to the current report, see "Transitioning to the New Custom Reports," page 23.

■	Payment Exception Detail Report—all gateway and processor exceptions in the given interval. Merchants use the report to identify any exception errors or data mismatches across gateway and processor submissions.

■	Processor Events Detail Report—all events provided by the processor regarding the transaction life cycle. Merchants use this report to manage their entitlement/commerce/CSR systems to keep the most current information regarding the transaction status.

■	Invoice Summary Report—this report provides a count of billable services provided by CyberSource to a merchant and is available only as a monthly report. This report includes transactions between 12:00 a.m. PST on the first day of the month and 11:59:59 p.m. PST on the last day of the month.

Merchant Account Reports

These reports are currently available for merchants processing with Global Payments and AliPay:

■	Processor Settlement Detail Report—all transactions that settle with the processor which can include positive (capture) and negative (credit) submissions. Merchants use this report to manage their entitlement/commerce/CSR systems, including product fulfillment.

■	Fee Summary Report—a summary of monthly fee information. This report should be configured as a monthly report, with the start date after the 8th of the month.

■	Fee Detail Report—all processor fee details from the processor funding details. Merchants reconcile this report with their processor contract pricing and funding detail reports.

■	Funding Detail Report—all transactions that are funded in the given interval. Merchants use this report to reconcile the transactions activity with the funding deposits from the processor.

■	Aging Detail Report—all settled transactions that have not been funded reported by age. Merchants require this information in order to ensure that they can track those transactions for which they are expecting payment.

■	Chargeback And Retrieval Detail Report—all chargeback and retrieval transactions reported from the processor. Merchants use this report to manage chargeback and retrievals and evaluate their risk performance metrics.

■	Deposit Detail Report—all funds transfers posted to the bank account and is summarized by category (for example, Chargeback, Settlement).

Creating a Report

When you select a report type, required fields are automatically included. You can add fields to the report as necessary.

If you would like to create a report that closely resembles reports in the Classic Business Center, you should: ■ Create the report to run on a daily frequency. ■ For the Payment Batch Detail Report, the report should start at 12:00 a.m. PST. ■ For all other reports, the report should start at 12:00 a.m. in the merchant's configured time zone. ■ Use the tables in Chapter 2, "Report Field Mappings," on page 23, to choose the fields for either the SCMP or the SO API naming conventions.

To create a report:

Step 1

In the left navigation panel, click the Reports icon.

Step 2

Click Manage Reports.

Step 3

Click the plus sign at the bottom of the page.

Step 4

Enter a report name.

Step 5

From the Frequency drop-down menu, choose the interval at which the report is to be generated:

■

One Time

■

Daily

■

Weekly

■

Monthly

Step 6

From the Report Type drop-down menu, choose a report.

Step 7

Choose a report format: XML or CSV.

Step 8

From the Report Start Time drop-down menu, choose the time of day for the reports to be generated.

Step 9

From the Timezone drop-down menu, choose the time zone.

Step 10

From the Application drop-down menu, select one or more application types to include in the report. By default, all application types are included.

Only the application type(s) you select are returned in the report, even if a related application type exists for the transaction. For example, if you filter by ics_auth, and the transaction also includes a related ics_bill application, only the ics_auth application appears in the report.

Step 11

Select the checkbox if you want the results to show credit amounts as negative values.

This option is automatically selected for all reports created in the Classic Business Center.

Step 12

Under Report Fields, expand a category and select the additional fields that you want to include in the report. Click Expand All to view all available fields at once.

Fields are added to the Selected list as you select them.

Step 13

Click Save.

 

Downloading Reports

To download a report:

Step 1

In the left navigation panel, click the Reports icon.

A list of all available reports appears on the main reports page.

Step 2

From the Frequency drop-down menu, choose an option.

Step 3

Choose a date range.

Step 4

Click the CSV or XML icon for the report you want to download.

 

Editing Reports

To edit a report:

Step 1

In the left navigation panel, click the Reports icon.

Step 2

Click Manage Reports.

Step 3

Choose the report that you want to edit.

Step 4

Make the necessary changes to the report.

Step 5

Click Save.

 

Deleting Report Subscriptions

To delete a report subscription:

Step 1

In the left navigation panel, click the Reports icon.

Step 2

Click Manage Reports.

Step 3

Choose the report that you want to delete.

Step 4

Click Delete.

 

Frequently Asked Questions

Who can use custom reports?

Merchant and account-level users and resellers can use the Custom Reports feature to download reports and to create, edit, or delete subscriptions. Account-level users (SSO) can also download the reports that their MIDs create. Users with View/Download Reports permissions can use the Custom Reports feature.

Account-level users cannot create reports on behalf of their merchants. This feature is not yet available.

How soon will my generated report be ready?

Daily recurring reports are available for download within 6 hours of the report start time. Weekly, monthly, and one-time reports might take longer than 6 hours.

Can custom reports be downloaded programmatically?

At this time, the reports cannot be downloaded programmatically. This feature is not yet available.

Is there a limit to the size of a generated report?

The report can be any size, but it might take more time to download depending on the file size and the user’s network speed.

Which report fields can I add to a custom report?

Refer to "Report Fields Available," page 69, which contains a list of available fields in each report.

Where can I find report field descriptions?

Refer to "Report Field Definitions," page 43, for field descriptions.

How can I identify declined authorizations in my reports?

In the Transaction Request Report, authorizations are recorded in the ApplicationName field as ics_auth. If the authorization was declined, the value in the RCode field will be 0. Additional information related to the decline can be found in the RFlag and the RMsg fields.

How do I interpret the rFlag for an authorization?

For more information, see:

https://www.cybersource.com/developers/other_resources/quick_references/reply_flags/

Which browsers are supported?

Internet Explorer 10 and 11, and the latest two versions of Google Chrome, Firefox, and Safari.

Should the Fee Detail report totals match the fee total on the Net Funding panel?

Fee details report totals should match the total on Net Funding panel.

For daily merchants, the interchange, discount, and standard assessments are detected daily and should be reflected in the Net Funding panel. There are also some month-end fees, such as authorizations, that are detected at the end of the month and would match in the Net Funding panel on that particular day.

For monthly merchants, there are not any fee details in a daily report because fees are charged only at the month-end. On that particular day, the report should match the Net Funding panel.

Should the Deposit Detail report totals match the Net Funded totals in the Net Funding panel?

Yes.

Should the Funding Detail report totals match the Net Funded totals in the Net Funding panel?

No. Funding details totals are a positive amount. The total in Net Funding is obtained after subtracting chargebacks, fees, and any other negative amounts.

Should the Funding Detail report match the Deposit Detail report?

Yes.

Should the Chargeback Detail report totals match the Net Funding panel?

Yes. Only the first and second chargebacks have financial impact to merchants. If you count the first and second chargebacks in the Chargeback detail report, that should match Net Funding.

What is the reporting cycle of the Invoice Summary Report?

The Invoice Summary Report contains transactions that happen between 12:00 a.m. PST on the first day of the month and 11:59:59 p.m. on the last day of the month.

How does the data listed in the Classic Business Center Payment Batch Detail Report reconcile with the same report in the New Business Center?

If you would like to configure your new Payment Batch Detail report to contain the same transactions that appear in the same report in the Classic Business Center, then schedule the report to begin at 12:00 a.m. PST. In this case, the two reports will contain the same transactions.

Should the Classic Business Center Payment Batch Summary Report match the Net Funding panel?

Yes.

Can you tell me if the Acquirer Reference Number (ARN) is reflected in any of our acquiring reports?

It is exposed as Transaction Reference Number in our reports. GPN returns the ARN which is a combination of CYBS trans_ref_no with something specific from Global Payments,

Why can’t I change the time and timezone of the Invoice Summary Report?

The Invoice Summary Report is designed to run on the same cycle as CyberSource monthly billing. This report is expected to contain the transactions that are billed for the month.

How can I get a one-time Invoice Summary report to cover the same period of time as my CYBS invoice?

To create a one-time Invoice Summary report that reflects a CYBS invoice, select the start date as the first day of the month; the end date as the last day of the month; and time zone as GMT.