Report generation and setup fields

This table contains the fields that are used when you set up or create your reports.

Field Description

Administration Code

Displays the unique code that identifies your company.

Batch ID

Enter the batch number in the field.

If you do not know the batch number, use the Transfer Batch report from the Reports menu. Enter 0 in the Batch ID field to display details of all batches.

Alternatively, you may want to see the page where all paid batches are located. To do this:

Select the Financial Status page from the left-hand menu. Locate the Transfer Summary.

Select the Transfer Currency or Amount hyperlink in the Total to be Transferred field. The Account Batch page displays. This page includes details of all transfer batches.

Batch ID (TB)

Enter the batch number in the field, or enter 0 (zero) to display all batches.

Clear Form button

Clears all your settings on the current report parameters page so you can start afresh.

Event

Select a payment status from the drop-down list. The 'all statuses' option is the default.

The report outputs payments that reached the payment status you select within the date range specified in the Date From and Date Until fields.

Format

Select the format of the report from the drop-down list:

  • Web page - an HTML document suitable for a web page

  • Excel spreadsheet - an XML file suitable for Microsoft Excel

  • Comma separated text - in a simple format where each element is separated by a comma and the report is output in a .CSV file

  • PDF - in the layout of the web page option but as a PDF file

  • Tab separated text - in a simple format where elements are separated by tab spaces and the report is output as a .TXT file

  • CSV.Gzip or CSV.zip - CSV (comma-separated values) format

From date

Enter a date or date and time in the From Date to specify the start date of your chosen date range. If you do not specify a time then the default time applies, which is 00:00 at the start of the day.

The date must be entered in the format: yyyy-mm-dd and the time in the format: hh:mm. The easiest way to specify a From Date is to select the calendar icon and then select a date and time. The field is then automatically populated. If preferred, you can type in a date or use the today and yesterday links.
Please note that the dates you enter must fall within a 31-day period.

Generate button

Select this button to generate the report.

Go back button

Select this button to return to the report parameters page.

Invoice Number

Enter the full invoice or a partial invoice number and a wildcard. If a wildcard character is required then a (%) percentage character must be used as the wildcard.  It can only be placed after 1 or more characters have been entered.

Note that the search is case-sensitive.

Invoice Period

Select an invoice period from the drop-down list.

Last Event

Select the Last Event check box, if required.

Use the Last Update option to report on those payments that are currently at a particular status. For example, to report on those payments that are at the AUTHORISED payment status but have not yet reached the CAPTURED payment status or payments that have reached CAPTURED but have not yet reached the SETTLED status.

Manage Report Column Configurations

Select the Create button next to Saved Report Format to create a new column configuration based on a standard configuration (the Statement).

If you have created your own reports they are displayed in the Edit or Delete your own Configurations section. The Edit and Delete buttons enable you to amend or remove your own reports.

For further details about creating a new report, refer to Configure your own Reports.

Manage the Report Parameter Sets

Displays a list of the available report parameter sets. Each parameter set has a reference name or number in the Reference column.

Use the Load button to load an existing parameter set which you can then amend or the Delete button to delete a parameter set.

For further details about creating report parameter sets, refer to Create Report Parameter Sets.

Manage the Report Schedules

Displays a list of the available report schedules. Each schedule has a reference name or number in the Reference column. The schedule description column informs you exactly when the report automatically generates. Use the Load button to load an existing schedule which you can then amend or the Delete button to delete a schedule.

For details about scheduling, refer to Scheduling the Report.

Merchant Code

An account identification code. Your company may have several accounts and for each account you will receive a merchant code from the Payment Service.

Merchant Code Filter

Select the merchant code you require from the drop-down list if you have more than one merchant code.

If there is only one merchant code for your administration, displays that merchant code.

Output

Two or more of the following output parameters will displayed, depending on the report. Select one of the following options.

  • To display the report on your screen select the Show on Screen radio button. To display the report in a new window, additionally check the Open in New window checkbox.

  • To receive the report via email, select the Email me the Report radio button and enter the relevant email address. Select the Use merchant's locale if applicable checkbox if required. (Only applicable, if you have enabled Locale settings on the Configuration page under the Profile menu.)

  • To schedule the report, select the Schedule the Report radio button and complete the fields, as applicable. Enter a reference name or code in the reference field, so you can recognize the report schedule.

Saved Report Format

Select a Saved Report Format from the drop-down list. The default is 'statement'.

If you have created your own reports by using the Manage Report Column Configurations section of this report then the names of your reports are displayed in the drop-down list, which you can select.

Until Date

Enter a date or date and time in the Until Date to specify the end date of your chosen date range. If you do not specify a time then the default time applies, which is 00:00 at the start of the day.

The date must be entered in the format: yyyy-mm-dd and the time in the format: hh:mm. The easiest way to specify a Until Date is to select the calendar icon and then select a date and time. The field is then automatically populated. If preferred, you can type in a date or use the today and yesterday links.
Please note that the dates you enter must fall within a 31-day period.

Guide feedback?
Email us at: guides@worldpay.com

© FIS 2023, and/or its subsidiaries. All rights reserved.