Order Payment Status Report
Payment Services for ÃÛ¶¹ÊÓƵ Commerce and Magento Open Source offers you comprehensive reporting so that you can get a clear view of your store’s transactions, orders, and payments.
There are two available Order payment status reporting views to enable you to quickly view the payment status of your orders:
- Order payment status visualization view—Chart available on the Payment Services Home that is a visual representation of aggregated payment statuses per day from the Order payment status report view
- Order payment status report view—Report available in Order payment status that shows detailed payment, invoiced, shipped, refund, and dispute statues for all transactions
The Order payment status views help you easily understand where a specific order is within the order to cash process flow. These reports allow you to quickly view orders—based on their payment status and payment date—and identify any potential issues.
You can download Order payment statuses in a .csv file format for use in existing accounting or order management software.
Order payment status data visualization view
The Order payment status data visualization view is available in the Payment Services Home. It is a visual representation of the aggregated payment statuses per day from the detailed tabular Order payment status report view.
On the Admin sidebar, go to Sales > Payment Services > Orders to see the data visualization chart of payment statuses.
{width="800" modal="regular"}
Click View Report to navigate to the detailed tabular Order payment status report view.
Customize statuses timeframe
By default, 30 days of payment statuses are shown.
From the Order payment status visualization view, you can customize the timeframe for the payment statuses you want to view by selecting a date range:
- On the Admin sidebar, go to Sales > Payment Services. The Order payment status data visualization view is visible in the Orders section.
- Click the Range selector filter.
- Choose the applicable date range—30 days, 15 days, or 7 days.
- View the statuses info for your specified dates.
Statuses information
The payment statuses for a selected date range are shown on the left of the Order payment status data visualization view. The dates for the selected date range are shown on the bottom of the view. If there were no orders on a particular date, that date does not appear.
The Order payment status data visualization view includes the following information.
Order payment status report view
The Order payment status report view is available in the Home view of Payment Services. It includes detailed statuses—payment, invoiced, shipped, refund, dispute, and more—for all transactions.
On the Admin sidebar, go to Sales > Payment Services > Orders > View Report to see the detailed tabular Order payment status report view.
{width="800" modal="regular"}
You can configure this view, per the sections in this topic, to best present the data you desire to see.
You can download payout transactions in a .csv file format for use in existing accounting or order management software.
DESC
) by default using the TRANS DATE
. The TRANS DATE
is the date and time when the transaction was initiated.Payment status updates
Certain payment methods require a period of time to capture the payment. Payment Services now detects the pending statuses of a payment transaction in an order by:
- Synchronously detecting
pending capture
transactions - Asynchronously monitoring
pending capture
transactions
Synchronous detection of Pending capture transactions
Automatically detect capture transactions in a Pending
status and prevent orders from entering a Processing
status when such a transaction is detected.
During customer checkout or when an admin creates an invoice for a previously authorized payment, Payment Services automatically detects capture transactions in a Pending
status and shifts corresponding orders into Payment Review
status.
Asynchronous monitoring of Pending capture transactions
Detect when a pending capture transaction enters a Completed
status so merchants can resume processing the affected order.
To make sure this process works as expected, merchants must configure a new cron job. Once the job is configured to run automatically, no other interventions are expected from the merchant.
See Configure cron jobs. Once configured, the new job runs every 30 minutes to fetch updates for orders that are in a Payment Review
status.
Merchants can check the updated payment status via the Order payment status report view.
Data used in the report
Payment Services uses order data, and combines it with aggregated payment data from other sources (including PayPal), to provide meaningful and highly useful reports.
Order data is exported and persisted in the payment service. When you change or add order statuses or edit a store view, store, or website name, that data is combined with payment data and the Order payment status report is populated with the combined info.
There are two steps in this process:
-
The index is changed data either
ON SAVE
(every time order info or store info is changed) orBY SCHEDULE
(on a pre-configured cron schedule), depending on how it is configured in Index Management in the Admin.By default, data indexation occurs
ON SAVE
, which means that whenever something changes in the order, the order status, the store view, the store, or the website, the reindexation process happens immediately. -
The indexed data is sent to the payment service, which then populates into the Order payment status report.
The only data that is exported and collated for reporting purposes is data used by the Order payment status report.
DESC
) by default using the ORDER DATE
. The ORDER DATE
is the date timestamp when the order was created.Configure data export
Even though, by default, reindexing happens in ON SAVE
mode, it is recommended that you index in BY SCHEDULE
mode. The BY SCHEDULE
index runs on a cron schedule of one minute, and any changed data appears in your Order status report within two minutes of any data change. This scheduled reindexing helps you reduce any strain on your store, especially if you have a large volume of incoming orders, because it happens on a schedule (not as each order is placed).
You can change the index mode—ON SAVE
or BY SCHEDULE
—in the Admin.
To learn how to configure the data export, see Command-line configuration.
Select data source
In the Order payment status report view, you can select the data source—Live _ or Sandbox—for which you want to see report results.
{width="300" modal="regular"}
If Live is the selected data source, you can see report information for your stores that use Payment Services in production mode. If Sandbox is the selected data source, you can see report information for sandbox mode.
Data source selections work as follows:
- If you do not have any stores that use Payment Services in Live mode, the data source selection defaults to Sandbox.
- If you have any stores (one or multiple) that use Payment Services in Live mode, the data source selection defaults to Live.
- Report exports always honor the data source selection.
To select the data source for your Order Payment Status report:
-
On the Admin sidebar, go to Sales > Payment Services > Orders > View Report.
-
Click the Data source selector filter and select Live or Sandbox.
The report results regenerate based on the data source selected.
Customize Order dates timeframe
From the Order payment status report view, you can customize the timeframe of the status results you want to view by selecting specific dates. By default, 30 days of order payment statuses are shown in the grid.
- On the Admin sidebar, go to Sales > Payment Services > Orders > View Report.
- Click the Order dates calendar selector filter.
- Choose the applicable date range.
- View the order payment statuses for your specified dates in the grid.
Filter report info
From the Order payment status report view, you can filter the statuses results you want to view by selecting filter criteria.
- On the Admin sidebar, go to Sales > Payment Services > Orders > View Report.
- Click the Filter selector.
- Toggle the Pay Status options to see report results for only selected order payment statuses.
- View report results within an order amount range by entering a Min Order Amount or Max Order Amount.
- Click Hide filters to hide the filter.
Show and hide columns
The Order Payment Status report shows all available columns of information by default. You can, however, customize which columns you see in your report.
-
On the Admin sidebar, go to Sales > Payment Services > Orders > View Report.
-
Click the Column settings icon ( {width="20" modal="regular"}).
-
To customize which columns you see in the report, check or uncheck columns in the list.
The Order payment status report immediately shows any changes that you made in the Column settings menu. The column preferences are saved and remain in effect if you navigate away from the report view.
View statuses
The Order payment status report view shows comprehensive pay status information for each order.
By default, 30 days of order payment statuses are shown in the grid.
Scroll to the left and right to view order payment status information, including order date, authorized date, invoiced, shipped, pay status, and more.
The number of rows returned in a search, or shown in the default 30 days of order payment statuses, are shown above the Order payment status view grid alongside the Order dates calendar selector filter.
Pay status
The Pay status column shows the current status for any payment. A Capture failed
payment shows a red alert status and a Voided
payment shows a gray alert status.
Refund status
The Refund status column shows the current status for any refund. A Capture failed
payment shows a red alert status and a Voided
payment shows a gray alert status.
Update report data
The Order payment status report view shows a Last updated timestamp that shows the last time that the report information was updated. By default, Order payment status report data is auto-refreshed every three hours.
You can also manually force a refresh of the Order payment status report data to see the most up-to-date report information.
-
On the Admin sidebar, go to Sales > Payment Services > Orders > View Report.
-
Click the Refresh icon ( {width="20" modal="regular"}).
The Order payment status report data is refreshed, an Update complete confirmation appears, and the latest information is present in the grid.
View disputes
You can view any disputes on your store’s orders, and navigate to the PayPal Resolution Center to take action on them, from within the Order payment status report.
-
On the Admin sidebar, go to Sales > Payment Services > Orders > View Report.
-
Navigate to the Disputes column.
-
View any disputes for a specific order and see the dispute status.
-
Review dispute details from the by clicking the dispute ID link that begins with PP-D-.
-
Take appropriate action for the dispute, as needed.
To sort order disputes by status, click the Disputes column header.
Download order payment statuses
You can download a .csv file with all statuses visible in the Order payment status view grid, whether you are viewing the default 30 days of statuses or a customized timeframe.
-
On the Admin sidebar, go to Sales > Payment Services > Orders > View Report.
-
If you want to see statuses for a timeframe other than the last 30 days, customize the date range timeframe for your statuses.
-
Click the Download (
{width="20" modal="regular"}
) icon.
Your order payment statuses are downloaded in a .csv format.
Column descriptions
Order payment status reports include the following information.