Manage Downloadable Reports

You must be logged in to the to manage reports. See Get Started with Reporting for account and login prerequisites.

generates and stores reports to which you subscribed on the Available Reports page. These reports include standard, preconfigured reports that you enabled and any custom reports you created. For a list of fields and descriptions you can include in downloadable reports, see Field Reference.

Partners and account-level users can also create reports that consolidate data for one or all merchants, or a selected group of merchants, in their portfolios.

Some merchants, including those processing alternate payment methods, might have access to financial data. For more information about these types of reports, see Financial and Reconciliation Reports.

For background on how report frequency, generation timing, and file retention work, see Report Generation and Timing.

Download Available Reports

You can download any report after the completes the request and makes your file available. Daily, recurring reports are available for download within six hours of the report start time. Weekly, monthly, and one-time reports might take longer than six hours to generate.

XML downloadable reports do not guarantee field order. XML industry standards do not require field order to be specified, and all industry-standard XML parsers are compatible with unordered elements. If you need fields in a specific order, use CSV format and configure the field order in the Field Ordering tab.

1. On the left navigation panel, click the Reporting icon.
2. Under Downloadable Reports, click Available Reports. The Available Reports page appears.
3. Click the tab containing the report you want to download.
4. In the Download column, click the file format link. Only reports that have successfully completed generating and contain data include links.
5. Follow your browser's instructions to open and save the file.

Keyword Filters

Use the Keyword filter in the search toolbar to filter the contents on the Available Reports page. When you enter a string into the keyword filter, the searches across all columns on the screen.

Example: Enter "18" in the Keyword filter to find any report with "18" in the Report Name, Generate Date, or Date Range fields.

Example: Enter "batch" in the Keyword filter to find any report with "batch" in the Report Name or Report Type fields.

One-Time Reports

Use to create one-time reports, which are useful when:

• You need information about transactions that occurred 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, making a recurring subscription unnecessary.
• You need information from before the previous 31 days.

To protect system performance, each user can generate up to three one-time reports concurrently. Additional one-time reports can be scheduled after the first three reports are generated.

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

To create a one-time Invoice Summary report that matches your monthly invoice, set the start date to the first day of the month, the end date to the last day of the month, and the time zone to GMT.

One-time reports use the same configuration form as recurring subscriptions, but are accessed through the Available Reports page rather than Report Subscription Management. To create a recurring subscription, see New Custom Report Subscriptions.

Generate a One-Time Report

1. On the left navigation panel, click the Reporting icon.

2. Under Downloadable Reports, click Available Reports. The Available Reports page appears.

3. On the Custom Reports tab, click Create Report. The Create Report Subscription page appears.

4. Account level (partner) users only: Under Account Setup, choose if the report data is retrieved from a merchant or a group of merchants. Then choose an available value in the Merchants or Groups list or use the default value to include all merchants or groups.

5. Under Basic Report Setup, enter this field information:

   In this field	Do this
   Report Name	Enter the name for your report that best reflects the data you want to capture. Each report must have a unique name containing up to 250 characters.
   Report Type	Select the type of report that most closely represents the data or process you want to include. For more information about report types, see Reports Available in . automatically includes the most commonly used fields in your report based on this selection. See the next step for more information on how to customize these values.
   File Format	Choose whether the creates the report in XLS or XML format.
   Frequency	Choose One-time. To create a recurring report subscription, see Standard Report Subscriptions.

6. To change any of the default fields included in your report, click the Arrow icon to expand the Advanced Report Features section. Then perform one or more of these actions. The available actions depend on the report type and format you choose:

   In this field or tab	Do this
   Credit Amounts	Check the box if you want credits to appear as negative amounts. For example: -1390.00.
   Naming Convention	Select how you want the field names to appear in the report: Simple Order API displays most of the field names in your report in camel case (for example: FirstName); SCMP displays most of the field names in your report with underscores (for example: first_name).
   Application	Select one or more types of transactions you want to include in the report. Leave blank to include all types.
   Connection Method	Select one or more connection methods used to perform the transaction that you want to include in the report. Leave blank to include all types. Available only for reports that include the Source field.
   Payment Channel	Select one or more payment channels used to perform the transaction that you want to include in the report. Leave blank to include all types.
   Field Selection	Enter text matching a field name you want to find in the Search field, or check the box for one or more fields or field types to include or remove from the report; check the Select All box to add or remove all fields. Click the Arrow icon in a section to expand or collapse it. In the Selected column, click the Delete icon to remove a field or field type from the report.
   Field Ordering	Click and hold the Handle icon to rearrange fields in the Selected column on the Field Selection tab into the order in which you want them to appear in the report. This option is only available for CSV output. XML field ordering cannot be guaranteed.

7. When you are done, click Create. The Available Reports page displays and the new report appears in the Custom Reports List.

Standard Report Subscriptions

You can enable or disable a subscription for any standard report. You can also change the frequency and output format of any standard report. automatically generates reports for enabled subscriptions and makes them available on the Available Reports page.

To save a standard report as a template, click Save As to create a new custom report. You can change the report details of the new report, including subscription cycle and included data. For more information, see New Custom Report Subscriptions.

Modify a Standard Report Subscription

1. On the left navigation panel, click the Reporting icon.

2. Under Downloadable Reports, click Report Subscription Management. The Report Subscription Management page appears.

3. Click the Standard Report Subscriptions tab. The Standard Report Subscriptions List appears.

4. Select one or more of these actions:

   • In the Enable column, select the box to activate the subscription; deselect the box to inactivate it.
   • In the Frequency column, click the Down Arrow icon to modify how often the report is generated.
   • In the Format column, click the Down Arrow icon to modify the file format of the report.
   • Click Save As to create a new version of the report. For more information, see Save a Report as a New Subscription.

Multi-Currency Reports

Multi-currency transactions involve a conversion of funds from the currency in which the transaction is processed to the currency actually deposited in the merchant's account. Multi-currency reporting includes exchange rate conversion data so you can reconcile the multi-currency transaction with the corresponding deposit.

You can create reports in the that include the original and local amounts for each transaction, and the exchange rate applied, by modifying the standard Funding Detail report. When you modify the Funding Detail report, it becomes a new custom report subscription.

Only some acquirers provide multi-currency data. Contact Customer Support to determine if your payment processor supports this feature.

Create a Multi-Currency Report Subscription

1. Follow the steps in Standard Report Subscriptions to find the Funding Detail Report standard report subscription.

2. Click the Save As icon. The Save As New Subscription page appears.

3. Click the Standard Report Subscriptions tab. The Standard Report Subscriptions List appears, and the Report Type list displays Funding Detail Report.

4. Enter a unique report name, and select the frequency and output for your report.

   Global Payment (GPN) merchants: Because multi-currency data is not delivered to the before the 5:00 p.m. report generation time, be sure to select the 11:00 p.m. option in the Subscription Start Time list.

5. In the Advanced Report Features section, click the down arrow. The panel expands.

6. On the Field Selection tab, scroll down to the Funding fields section, then click the down arrow to expand the section.

7. Add these Funding fields to the report:

   • Exchange Rate
   • Exchange Rate Date
   • Local Amount
   • Local Currency
   • Original Amount
   • Original Currency

8. Click Save As. The Report Subscription Management page appears.

9. To view the new report, click the Custom Report Subscription tab.

Custom Report Subscriptions

The enables you to create your own reports based on the type of data you want to track such as authorizations, sales, or refunds. When you create a report subscription, the provides a default set of fields for you to choose from. You can also add and remove additional fields based on your needs, choose the order in which they appear, and how they display in the report. For a list of fields and descriptions, see Field Reference.

You can also set how often you want to generate the custom report (one-time or recurring). Successfully generated reports appear on the Available Reports page. To create a custom report subscription, you can create a brand new subscription or save an existing standard or custom report as a new report.

New Custom 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. You can maintain up to 20 report subscriptions at any time.

In addition to choosing from available fields, you can customize these 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 reports that can be customized. The report type cannot be changed after a report is created.
• Format: the format of a generated report (XML or CSV).
• Frequency: the frequency at which a report runs (daily, weekly, or monthly).
• Start time: the time of day at which a report runs.

Recurring subscriptions use the same configuration form as one-time reports, but are created through Report Subscription Management rather than the Available Reports page. To generate a one-time report, see One-Time Reports.

Create a Custom Report Subscription

1. On the left navigation panel, choose Reports > Downloadable Reports > Report Subscription Management. The Report Subscription Management page appears.

2. Click the Custom Report Subscriptions tab. The Custom Reports Subscriptions List appears.

3. Click Create Subscription. The Create Report Subscription page appears.

4. Account level (partner) users only: Under Account Setup, select whether to base the report on data from a specific merchant or a group of merchants; then choose an available value in the Merchants or Groups list or use the default value to include all merchants or groups.

5. Under Basic Report Setup, enter this field information:

   In this field	Do this
   Report Name	Enter the name for your report that best reflects the data you want to capture. Each report must have a unique name containing up to 250 characters.
   Report Type	Select the type of report that most closely represents the data or process you want to include. automatically includes the most commonly used fields in your report based on this selection. See the next step for more information on how to customize these values.
   File Format	Choose whether the creates the report in XLS or XML format.
   Frequency	Choose Recurring subscription to automatically generate daily, weekly, or monthly reports. To create a one-time report, see One-Time Reports.

6. To change any of the default fields included in your report, click the Arrow icon to expand the Advanced Report Features section, and then perform one or more of these actions. The available actions depend on the report type and format you select:

   In this field or tab	Do this
   Credit Amounts	Check the box if you want credits to appear as negative amounts (for example: -1390.00).
   Naming Convention	Select how you want the field names to appear in the report: Simple Order API displays most field names in camel case (for example: FirstName); SCMP API displays most field names with underscores (for example: first_name).
   Application	Select one or more types of transactions you want to include in the report. Leave blank to include all types.
   Connection Method	Select one or more connection methods used to perform the transaction that you want to include in the report. Leave blank to include all types. Available only for reports that include the Source field.
   Payment Channel	Select one or more payment channels used to perform the transaction that you want to include in the report. Leave blank to include all types.
   Field Selection	Enter text matching a field name you want to find in the Search field, or check the box for one or more fields or field types to include or remove from the report; check the Select All box to add or remove all fields. Click the Arrow icon in a section to expand or collapse it. In the Selected column, click the Delete icon to remove a field or field type from the report.
   Field Ordering	Click and hold the Handle icon to rearrange fields (in the Selected column on the Field Selection tab) into the order in which you want them to appear in the report. This option is only available for CSV output. XML field ordering cannot be guaranteed.

7. When you are done, click Create. The Manage Report Subscription page appears and the new subscription appears in the Custom Reports Subscriptions List.

Save a Report as a New Subscription

You can choose to save any existing custom report as a new report. This option enables you to copy all the existing values into the new report and to change them to create a new report with a new name.

1. On the left navigation panel, click the Reporting icon.

2. Under Downloadable Reports, click Report Subscription Management. The Report Subscription Management page appears.

3. Click the Custom Report Subscriptions tab. The Custom Reports Subscriptions List appears.

4. Next to the report you want to copy, click the Save As icon. The Save New Subscription page appears.

   Under Account Setup, select whether to base the report on data from a specific merchant or a group of merchants, then choose an available value in the Merchants or Groups list. To create a report that includes all merchants or groups, use the default value.

5. Under Basic Report Setup, enter a unique name for the report.

6. You must change at least one attribute or field to save the new report. Follow steps 5 and 6 in Create a Custom Report Subscription to update field and filter values.

7. When you are done, click Save As. The Manage Report Subscription page appears and the new report appears in the Custom Reports Subscriptions List.

Modify Custom Report Subscriptions

You can edit the values in a custom report (except the report name and frequency), or delete subscriptions you no longer need. You can also create a new report based on an existing subscription. For more information, see Save a Report as a New Subscription.

Edit a Report Subscription

1. On the left navigation panel, click the Reporting icon.
2. Under Downloadable Reports, click Report Subscription Management. The Report Subscription Management page appears.
3. Click the Custom Report Subscriptions tab. The Custom Reports Subscriptions List appears.
4. In the row containing the report you want to edit, click the Edit icon. The Edit Report Subscription page appears.
5. You must change at least one attribute or field to save the report. Follow steps 5 and 6 in Create a Custom Report Subscription to update field and filter values.
6. When you are done, click Edit.
7. Click Confirm. The Custom Report Subscriptions list refreshes with the edits you made applied.

Delete a Report Subscription

1. On the left navigation panel, click the Reporting icon.
2. Under Downloadable Reports, click Report Subscription Management. The Report Subscription Management page appears.
3. Click the Custom Report Subscriptions tab. The Custom Reports Subscriptions List appears.
4. In the row containing the report you want to delete, click the Delete icon.
5. Click Confirm. The Custom Report Subscriptions list refreshes and removes the subscription.

Configuring Payment Batch Detail Report Batch Times

You can use the Payment Batch Detail report to monitor the batch submission process and help predict your cash flow/funding timing. The batch date and time represents the date and time that the batched the transactions to the processors.

To ensure that the report contains the most recently batched transactions, schedule the 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.

There are nuances to consider when scheduling your Payment Batch Detail report because the report contains transactions with a batch date and time that occur within the given interval.

For some merchants, the batch cut-off time might occur after the end of the logical business day. For example:

• Your logical business day begins at 9:00 a.m. Pacific Time.
• Your logical business day ends at 6:00 p.m. Pacific Time.
• Your batch end time is 7:00 p.m. Pacific Time.

In this situation, schedule the report to begin at 8:00 p.m. Pacific Time so that it contains the transactions batched from the logical business day.

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

• Your logical business day begins at 9:00 a.m. Eastern Time.
• Your logical business day ends at 11:59 p.m. Eastern Time.
• Your batch cut-off time is 9:00 p.m. Eastern Time.

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. Schedule your report to begin at 10:00 p.m. Eastern Time, because transactions with a batch date after 10:00 p.m. Eastern Time appear on the following day's batch and report. You can also choose to schedule multiple Payment Batch Detail reports to suit your needs.

For some merchants, the batch date occurs 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. Eastern Time—a sale is authorized.
• May 3, 9:00 p.m. Eastern Time—the sale is captured (settled).
• May 4, 1:00 a.m. Eastern Time—The 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.

Available Report XSDs

Reports have XML schema definitions (XSDs) to validate the downloaded reports. Each report contains a set of common fields and fields specific to the report.

All other reports continue to use DTD format.