Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near real time. It enables you to view all the electronic payments in your Zuora tenant within the last 30 days. You can use this dashboard to identify and troubleshoot issues with electronic payments.
For more information about the System Health feature, see Zuora System Health.
The System Health feature is available only in the Production environments.
To access the Electronic Payments dashboard, ensure that the following requirements are met:
- System Health is enabled for your Zuora tenant.
- You are assigned the Access System Health Dashboard permission.
For more information, see Zuora System Health prerequisites.
If you cannot access it, check with your administrators.
Electronic payment metrics
The following table provides definitions of the Electronic Payment metrics.
Electronic Payment Usage
All electronic payments that are processed within a specified time range.
You can view the numbers of processed payments and failed payments by payment gateway.
Electronic Payment Failure
All the failed electronic payments within a specified time range.
The following filtering options are available:
The following details of the errors are available:
Electronic Payment Performance
The time (maximum, minimum, and mean) between when a payment is created to when the payment status turns to
View data in the Electronic Payments dashboard
The Electronic Payments dashboard is located under the System Health section in the left navigation. It contains three tabs that display the electronic payment usage, failures, and performance data separately.
After opening a tab, take the following steps to view the data.
You can customize the data to be displayed by using the filters.
- Click the Filters icon to expand the filter in the upper right of the dashboard.
- Use the Time Frame, Start Time, and End Time fields to specify the time range.
- Use the Gateway and Payment Method lists to select the Gateway and Payment Method you want to view.
On the Failures tab, you can also select the type of response code and currency to view.
- Click Apply to apply the filters, or click Reset to go back to the default filter configuration.
Use the Summary pane to get an overview of the data.
The Summary pane displays a summary of the selected data. For example, on the Overview tab, the Summary pane displays the following metrics of the selected electronic payments:
- Total number of the processed payments
- Total number of the failed payments
- Numbers of the processed and failed payments by payment gateway
View the trend charts.
- Select the time interval of the charts using the interval radio buttons on the top right of the chart.
Note that available interval options vary based on the length of the selected time range.
- When hovering over each time interval, you can view detailed data of that time range, which also displays the change percentage compared to the previous interval.
- On the Failures tab, the trend chart displays data differently depending on the filters that have been applied. You can drill down the data by clicking a bar on the chart.
- On the Performance tab, you can choose to hide or display lines on the chart by clicking the corresponding icon of a line.
Use the table below the trend chart to view the breakdown data within the selected time range.
- By default, the table displays all the data within the specified time range. You can narrow the scope down to a specific interval by clicking a bar in the chart. The Summary pane will be automatically updated to display the summary of the selected data set.
- On the Failures tab, use the filter in the upper right of the table to list the data you want to view. You can use the filter to retrieve failed electronic payments by payment method, response code, amount, currency, and the number of failed payments for a payment gateway. When you finish configuring the filter, click Apply. You can click Clear to un-apply the configuration.
- Some columns can be used to sort the data. You can click the header of a column to see if the data can be sorted by this column.
- You can download the table as a CSV file by clicking the download icon in the upper right of the table.
- On the Failures tab, you can view the details of a payment error by clicking Details of that failed payment. In the expanded view, you can view the following information:
- Zuora Response Code
- Gateway Response Code
- Gateway Response Message
- Recommended Actions
You can view details of the payment and the payment run processed the payment by clicking the corresponding payment number or source ID.