Useful Information about Reports

This page has useful information about all of the reports that you can generate. Some fields, columns or settings may not be visible depending on your permissions and how the reports are made.

Report Generation and Setup Fields

This table contains the fields that are used when you setup 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, you may want to refer to the Transfer Batch report from the Reports menu and select 0 (zero) in the Batch ID field to display details of all batches.

Alternatively, you may want to refer to 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 is displayed. This page displays 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 Type

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

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

The payment statuses in reports are slightly different to the statuses in the Business Manager. To see how they relate to each other, click here.

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 hypertext 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.

To learn more about creating a new Get Statement report, click here.

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.

To learn more about creating report parameter sets, click here.

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, click here.

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, also tick the Open in New window checkbox.

  • To receive the report via email, select the Email me the report radio button and enter your Email address. Tick the Use merchant's locale if applicable checkbox if required (only applicable if you have enabled Merchant Locale settings on the Configuration Details page).

  • To schedule the report, select the Schedule the report radio button and complete the boxes. Enter a reference name or code in the Reference box, so you can recognise the report schedule. Click the links to learn how to load/edit and delete report schedules.

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 or hh:mm:ss.

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.

 

A-Z of All Report Fields and Columns

This table contains a list of all the report fields in alphabetical order.

 

Field/Column Heading

Description

3D-Secure Result

The 3D-Secure result can be configured to appear in the Get Statement report. One of the following responses is possible:

Cardholder Authenticated - The cardholder entered their password correctly and their identity was successfully authenticated by the relevant card issuer.

Authentication offered but not used - The relevant card issuer or cardholder is not enrolled.

Authentication Unavailable - Authentication was initiated, but a system or connectivity issue between WorldPay, the Card Scheme and/or the Card Issuer, prevented authentication from being completed.

Ecommerce/Unknown – This result appears when authentication is not initiated for one of the following reasons:

  • The merchant is not enabled.

  • The card type is not supported by authentication.

For further details, refer to the Cardholder Authentication guide.

Acquirer Code

The acquiring bank's identification code.

Acquirer Account

The account identification that identifies the acquirer that the capture batch is sent to by the Payment Service.

Administration Code

A unique code that identifies your company.

Amount

The value of a transaction or the total value of a group of transactions.

Amount to Merchant Initiated

The amount transferred to your bank account.

Amount Transferred to Merchant

The amount transferred to your bank account.

Amount Transferred to Deposit

The amount transferred to your deposit by the Payment Service.

At Date

The date that a report or an activity begins.

Authorisation Code

A code provided by the acquirer to authorise a payment. It means the card has not been reported as lost or stolen and there was sufficient funds at time of authorisation.

Authorised Date

Date the payment was authorised.

AVS Result

The result of the Address Verification Service (AVS) check as returned by the acquirer. For further details, refer to the Fraud Screening guide.

Batch Details

Section that provides details about the transfer batch.

Batch ID

The specific batch number that identifies a transfer batch. A transfer report for a particular transfer batch is also identified by a Batch ID.

Batch ID Capture

The specific batch number that identifies a capture batch.

BTXid

The Batch Transfer identification code.

Captured Date

Date the payment was captured.

Cart ID

Shopping cart identification that was given to this transaction by your (the merchant's) system.

Chargeback Merchant Guarantee Amount

the WorldPay Guarantee transaction fee as applied to this payment, or where applicable, payments. Applies only to UK merchants who have purchased the WorldPay Merchant Guarantee.

Chargeback Merchant Guarantee Currency

The currency in which the Chargeback Merchant Guarantee Amount is applied at date of settlement. Applies only to UK merchants who have purchased the WorldPay Merchant Guarantee.

Charged Back

The total value of payments charged back in this period. The period date range is displayed in the Settled Purchases Between field.

Charged Back Amount

The amount charged back from the merchant's account.

Charges

Column heading for section detailing charges made by the Payment Service.

Commission Amount

The total of transaction-level service charges levied against the payment.

Commission

The total of transaction-level service charges levied against the payment.

Creation Date

The date and time the first payment status was given to the payment by the payment server.

Currency

A three letter currency code that identifies a currency. Refer to currency codes in the HTML Redirect guide.

Currency Code

A three letter currency code that identifies a currency. Refer to currency codes in the HTML Redirect guide.

CVC Result

The result of the Card Verification Code (CVC/CVV) check as returned by the acquirer. For further details, refer to the Fraud Screening guide.

Date Authorised -

The date the transaction was authorised.

Date Captured

The date the capture request is submitted to the acquirer.

Date

The date of a transaction, event, message, or other entity.

DescriptionTB

Displays exchange rate where applicable or gives details of items.

Description

Description of items in the report.

Deposit Correction

Adjustment made to the deposit for the relevant merchant code at the transfer date. Note that where the current deposit is less than the required deposit, then funds due to you at transfer are automatically transferred to the deposit until paid.

Note: In the Transfer batch view of the Finance section, this is known as the reserve adjustment.

Deposit Amount

Value held in deposit by the payment service.

Deposit Shortfall or Surplus

Current shortfall or surplus in the deposit account for this merchant code.

Details

Section of the Get Statement report that displays details for the column headings (fields) based on the standard configuration called "statement" or displays fields in the report you have chosen to display using the Saved Report Format field in the report parameters page.

Digital Wallet

Column heading of the Get Statement report that shows whether or not a transaction was made using a V.me wallet.

Dispute Reason

Chargeback reason (if given) by the financial institution.

Dispute Reserves Currency

The currency in which applies to the Dispute Reserves Amount.

Dispute Reserves Amount

Amount held in the Dispute Reserve for this transaction. Only populated where disputed.

Dispute Type

Type of Dispute.

Event Date

The date that the Event Type (payment status) was given by the payment server.

Event Type

The relevant payment status or payment event.

For a full list of payment statuses and their meaning, refer to Payment Status section of the Payments & Orders guide.

The payment statuses in reports are slightly different to the statuses in the Business Manager. To see how they relate to each other, click here.

Exchange Rate

The rate imposed by the financial institution to convert the currency the shopper paid in to your transfer currency. Note that the exchange rate is calculated at settlement.

From

From a specific date or time and date.

From Date

The date that starts a particular period. This period ends at the End Date or Until Date.

Funds Transaction Cost (FTC)

A transfer fee that is applicable where there is a transfer of funds to a bank account.

Gross Transaction Value

The total gross value of all transactions for the relevant settlement period.

InProcess Authorised Currency

The currency of the amount held in the In Process Authorised Amount field.

InProcess Authorised Amount

The balance on the IN_PROCESS_AUTHORISED account and represents the funds that are reserved (authorised) for you by the financial institutions. This amount is the amount that can (still) be captured.

InProcess Captured Amount

The balance in the IN_PROCESS_CAPTURED account represents the amount that is captured by the financial institutions on your behalf. This amount is the amount that can (still) be settled.

InProcess Captured Currency

The currency of the amount held in the In_PROCESS_CAPTURED account.

InProcess SentForAuth Amount

The balance in the IN_PROCESS_SENT_FOR_AUTH account.  

InProcess SentForAuth Currency

The currency of the amount held in the IN_PROCESS_SENT_FOR_AUTH account.

Item Costs

Costs of different subscription charges.

Invoice

Any charges specified in the weekly transfer invoice and the monthly invoice are deducted from this transfer. The invoices are emailed to you at the same time as the Transfer report and contain full details.

Invoice Date

 Date of this invoice.

Merchant

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

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 Commission Amount

The total transaction-level service charges levied against the payment. This is applied at date of settlement.

Merchant Commission Currency

The currency in which the Merchant Commission Amount is applied by the Payment Service. This is applied at date of settlement.

Merchant Guarantee Amount

Guarantee service charges made by the WorldPay Payment Service for this period. (Only applicable to UK-based merchants who have purchased the WorldPay Merchant Guarantee.)

Merchant Guarantee Service Charge (GSC)

Merchant Guarantee service charges made by the WorldPay Payment Service for this period. (Only applicable to UK-based merchants who have purchased the WorldPay Merchant guarantee.)

Merchant Guarantee Currency

The currency of the amount displayed in the Merchant Guarantee Amount field.

Net Amount

The amount after any charges or deductions have been made.

Net Amount Due

The  total amount of service charges due to the Payment Service and deducted at transfer.

Number

Number of transactions.

Order Code

A unique id given by the payment server to identify a payment.

Order Description

The description entered by the shopper to describe their order.

Other Amount

The amount of any extraordinary payments or deductions included in this batch. For example, special billing items.

Parameters

Displays the parameters you have chosen in the report parameters page.

Payment Amount

The amount of the payment as entered by the shopper at time of purchase.

Payment Amount in Transfer Currency

The amount paid by the shopper when converted to the transfer currency.

When multi-currencies are used by shoppers, this field provides details of the payment in the transfer currency. Note that when a payment is at AUTHORISED or CAPTURED then this is an indicative amount as the rate imposed by the financial institution to convert the currency is made at settlement.

Payment Amount Transfer Currency

The currency of the amount displayed in the Payment Amount in Transfer Currency field.

Payment Currency

The currency of the payment made by the shopper at time of purchase.

Payment Method

The type of card/payment method. For example, Visa, MasterCard, Amex.

Payment to Merchant Initiated

The payment to be transferred to your bank account.

Period Begin Date

Date the period began in which settled payments were collected.

Period End Date

Date the period ended in which settled payments were collected.

Refunded

The total amount of payments refunded in this transfer.

Refunded Amount

The total amount of refunded payments in this period.

Report Creation Date

Date the report was created.

Risk

'W' or 'C' indicates a Warning or Caution risk alert. An alert means that there may be an element of risk involved in accepting the payment. We recommend that you review payment and shopper details to assess the risk involved in accepting the payment. Refer to the Fraud Screening guide for further details.

Service Level Code

The code that identifies the particular services that the Payment Service is contracted to provide.

Settled

The total value of settled payments processed for this merchant code in this period. The period date range is displayed in the Settled Purchases Between field.

Settled Amount

The total value of settled payments in this batch.

Settled Purchases Between

The date range that indicates the period that settled payments were collected for the transfer batch.

Settlement Amount

The amount settled by the acquirer minus any deductions made by the Payment Service. This is the amount that will be/has been transferred to you.

If the payment is not yet settled, then this field is blank.

Settlement Currency

The currency in which the Payment Service transfers funds that are owed to you.

Settlement Date

Date the payment was settled to the Payment Service.

Shopper Address

The shopper's postal address, as entered by the shopper at time of purchase.

Shopper Country Code

The shopper's country code.

Shopper E-Mail Address

The shopper's email address, as entered by the shopper at time of purchase.

Shopper Name

The name of the shopper as entered by the shopper at time of purchase

Shopper Phone

The shopper's telephone number, as entered by the shopper at time of purchase.

Shopper Postal Code

The shopper's post code, as entered by the shopper at time of purchase (Zip code in the USA).

Subscription Fees

Where applicable, includes Monthly Service fee, Risk Management monthly fee and Guarantee fee.

Sub-total

Total of charges made by the WorldPay Payment Service before VAT or GST.

Summary

Summary details for some fields in the Details section of the report.

Tax Point

Date of Invoice.

Tax Invoice Date

Date of Invoice.

Tax Invoice Number

Unique number that identifies a particular invoice. You should use this number in any correspondence.

To Date

The end date of a period that starts with a From Date.

Total

Total charges for this invoice.

Total Amount

The total sum of the amounts.

Totals

Displays total sums for payments that have reached the SETTLED payment status.

Transaction Fees  

Last month's fraud screening charges, chargeback and refund fees.

Transaction ID

 A unique ID given by the payment server to identify a

Transaction Service Charge (TSC)

Transaction charges made by the WorldPay Payment Service for this period.

Transactions

The number of transaction or a list of transactions.

#Transactions

The number of transactions.

Transaction ID

A unique id given by the payment server to identify a payment.

Transfer Amount

The amount settled by the acquirer minus any deductions made by the Payment Service. This is the amount that will be/has been transferred to you.

If the payment is not yet settled, then this field is blank.

Transfer Currency

The currency in which the Payment Service transfers funds that are owed to you. This is the currency of the value displayed in the Transfer Amount field.

If the payment is not yet settled, then this field is blank.

Transfer Date

The date of transfer.

Transfer Initiated

Date of transfer of funds to your (the merchant's) bank account.

Transfer Summary

Heading for summary giving transfer details. If applicable, this section displays settled payments, refunds and chargebacks.

Until

Until a specific date or time and date.

Until Date

The date that ends a particular period. This period starts at From Date.

VAT/GST

Value Added Tax (VAT) or Goods and Sales Tax (GST) that is applicable. Rate may vary depending on your region.

Value

Column heading displaying the value of different items in the invoice.

Wallet Authenticated

Risk score associated with V.me wallet payments. Available on the Payment with Risk Detail report.