Skip to main content

Configurable Payment Retry dashboard

Zuora

Configurable Payment Retry dashboard

Configurable Payment Retry (CPR) Dashboard helps you view at-a-glance real-time status/health of collection actions specific to payment retry logic. The configurable Payment Retry dashboard is under the Administration > System Health section in the left navigation menu.

The CPR dashboard is automatically populated with data when Configurable Payment Retry is enabled to perform various retry strategies to improve your collections. For more information, see Configurable Payment Retry. The CPR Dashboard does not require any additional setup or access.

The CPR dashboard provides the following benefits:

  • View data related to payment retries in your Zuora tenant within the last three months.
  • Detect failures related to payment retry and troubleshoot accordingly.
  • View metrics along with raw data that is used to calculate the metrics.

For more information about the System Health feature, see Zuora System Health.

Prerequisites

To access this dashboard, ensure 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 this dashboard, check with your administrators.

Configurable Payment Retry tabs

The following table provides descriptions of the Configurable Payment Retry tabs.

Overview

This tab contains metrics of the chosen timeframe (up to three months) in graphs and quick stat cards.
In the Gateway Response Codes, you can view the top errors for failing payment retries.
You can link all the displayed graphs and metrics to raw data in the Payments, Payments Retry, and Retry Log tabs.

Payments

This displays the raw data corresponding to all the payments done in the chosen timeframe.

Payment Runs

This displays details of the payment runs that were started in the chosen timeframe.

Retry Log

This displays the retry details of all billing documents which were re-tried in the chosen timeframe.

View Configurable Payment Retry dashboard

This section is at the top of this dashboard, encompassing the following data boxes that display data summaries for the last three months.

After you open a tab in the dashboard, perform the following steps to view the data:

  1. Configure filters.

    You can customize the data to be displayed by using the filters.

    • Click Filters from the upper right corner of the dashboard.
    • Use the Timeframe, Start Time, End Time, and Currency to filter based on your need.
    • Click Apply to apply the filter or click Reset to go back to the default filter settings.
  2. Quick Stat Card metrics.

    The following table provides descriptions of the Quick Stat Card metrics.

    Metrics Definition

    Collection Rate

    The percentage of documents that went through the retry and were successfully collected.

    Documents Collected

    The total number of unique billing documents (debit memos and invoices) that were collected successfully through retry is also the document success rate.

    Amount Collected

    The total amount collected successfully through billing documents that went into retry.

    Payment Success rate

    The percentage of payments that were successfully collected through retry.

    Average Days Outstanding

    On average, the number of days it takes for a billing document to be successfully collected.

    • Each stat card has a trend number on the right. This depicts how the currently chosen timeframe has performed on each metric compared to a previous period.
    • Hovering over the stat cards, you can see the metric history from previous periods.
  3. Trend Chart metrics

    The following table provides descriptions of the Trend Chart metrics.

         Metrics

    Definition

         Collection Rate

    The percentage of documents that went through the retry and were successfully collected. The graph is depicted based on active customer groups.

    Document Retry Status

    The status of each of the documents that are in CPR. This graph is displayed based on active customer groups.

    The following items are the different types of statuses:

    • Complete - Retry completed successfully.
    • Complete-external - The document was collected externally.
    • Failure - The retry process failed.
    • In-retry - The document is still in the retry process.
    • Defunct - When the next retry time could not be assigned to a billing document due to some exception.

    Amount Collected

    The total amount successfully collected through billing documents. The graph is depicted based on active customer groups.

    Payment by Attempts

    The number of payments that were successful/failed at every attempt.

    Note: The first attempt is the initial payment run, the second attempt is the first retry cycle and so on.

    • Clicking on any portion of the graph will take you to the raw data used to generate the graphs (the Payments, Payment Runs, and Retry Log tabs).
    • Hovering over any of the graphs will show further details at every point in the graph.
  4. On the Gateway Error Response in the Overview tab, you can view gateway processing errors and top trending collection issues. The table displays the below details:

    Columns

    Definition

    Count

    The number of payments that have failed with a given combination of Gateway and Code and Description.

    Click on a particular Count in Gateway Error Response to view the list of payments that have failed with a given combination of Gateway and Code and Description.

    Gateway

    The failed payment gateway.

    Code

    The reason code for the payment failed.

    Description

    The description of the failed payment.

    Decline Type

    The decline type that was set in the CPR response code mapping.

    There are times when the decline type of a particular response code is changed within a given month, in which case only the latest decline type is displayed in this table. However, this does not affect any other details in this table.

    Number of Invoices

    The total unique number of invoices that failed with a given combination of Gateway and Code and Description.

    Collection Rate

    The percentage of documents which failed on the first retry with a given combination of Gateway + Code + Description but were eventually collected successfully (NOTE: this doesn't take into account the documents that were collected externally (outside CPR))

    This does not include documents collected externally (outside CPR).

  5. On the Payments tab, you can view the below details corresponding to data used to build the charts and stat cards:
    You can filter this data further based on any column value.
    • Payment Number
    • Status
    • Gateway
    • Error Code
    • Error Description
    • Attempt Number
    • Payment Total
    • Customer group
  6. On the Payment Runs tab, you can view the below details corresponding to data used to build the charts and stat cards:
    You can filter this data further based on any column value.
    • Payment Run
    • Start Date
    • End Data
    • Payment Processed
    • Amount Collected
    • Payment Success
  7. On the Retry Log tab, you can view the below details corresponding to data used to build the charts and stat cards:
    You can filter this data further based on any column.
    • Account Number
    • Document Number
    • Document Retry Status
    • Customer Group
    • Attempt Number
    • Next Attempt

All the data on the CPR dashboard is cumulative in nature and keeps updating as and when there are changes in the status of the billing documents.