Introduction to Payment Runs
Payment runs are used to collect payments using electronic payment methods, like credit cards or ACH. Even if a payment was made to an invoice but had an error, if an invoice has a positive balance and meets all the filter criteria for the payment run, Zuora will pick up the invoice for processing in the payment run.
A maximum of 200,000 invoices can be picked up for processing in one payment run.
You must have the Manage Payment Runs permission to create, edit, cancel, stop, and delete payments runs. See Payment Roles.
Types of Payment Runs
Zuora supports two type of payment runs: ad hoc and recurring. These are similar to ad hoc and scheduled bill runs (see Creating Bill Runs).
- An ad hoc payment run is a single payment run that you create manually.
- A recurring, or scheduled, payment run is automatically run on its scheduled dates and times once it has been configured.
Both types of payment runs will only collect for accounts with auto-pay enabled.
Payment Status
After a payment run is executed, each payment processed will show one of the following payment processing statuses:
- Processed: The payment was successfully processed.
- Error: An error occurred while processing the payment; review the error message and try processing the card again if necessary.
View Payment Runs
You can view all payment runs using two different views: Expanded View and List View.
- In the expanded view, you can post the payment run or cancel the payment run.
- The list view provides the option of deleting a payment run. This view can be sorted by its column headers.
Only the payment runs in the Cancelled and Error status can be deleted.
To the right of the expanded and list views is a summary of all payment runs, broken down by status, with the total number of payment runs in each status. You can sort a list of payment runs by run target date, executed on (date), number of payment runs, and status.
When a payment run is created in Zuora Collections Advanced Payment Manager or a retry attempt is executed in Configurable Payment Retry, an associated payment run is also created and visible in Payment Runs of Zuora Payments.
Payment Run use case
When you execute a payment run based on any filter criteria, the resulting selected invoice count may differ from the actual number of invoices.
This is because the selection criteria may not include all the invoices. For example the auto pay option may not be enabled for all the invoices and those invoices are excluded from the selected invoice count.
For example, you may get a count of 38 invoices as selected invoices out of the total 47 invoices if the auto-pay option is disabled.
If you have enabled the auto-pay option, the payments will be collected for those invoices, resulting in those invoices being included in the selected invoices count.
Selected invoices calculation for different scenarios:
|
Scenario |
Electronic Payment |
Total invoices from executing a payment run |
Unapplied Credit Memos |
Unapplied Payments |
Resulting selected invoices |
|---|---|---|---|---|---|
|
Use Case 1 |
Enabled |
100 |
60 |
30 |
60 + 30 + 10 = 100 |
|
Use Case 2 |
Disabled |
100 |
60 |
30 |
60 + 30 + 5 = 95 |
|
Use Case 3 |
Enabled |
100 |
0 |
0 |
100 where all the 100 invoices are considered and the total count becomes 100. This is because the electronic payment option is enabled. |
View an Individual Payment Run
You can find specific payment runs by either browsing (using expanded or list view) or searching payment runs.
The search function is on the right of the Payment Runs tab. You can search by Payment Run ID numbers.
In the search result, click the payment run ID and the payment run details page is displayed.
In the Basic Information section of the payment run details page, the Number of Invoices field shows the total number of invoices that picked up for processing in a payment run. You can get the total number of fully paid invoices in a payment run by using the value of Number of Invoices minus the value of Number of Unprocessed.
If a payment run is still being processed, only basic information is shown on the payment run details page. Once the payment run is completed, the following sections are displayed to provide you more information about the payment run.
- Payments Processed Successfully
- Payments Processed with Errors
- Credit Balance Applied
- Selected Invoice(s)
- Unprocessed Debit Memos
Change the Recipients of Payment Run Email Notifications
Email notifications for payment runs are sent to the Billing user who created the applicable payment run. If your company has a scheduled (recurring) payment run, you can redirect the email notifications for the payment run by performing the following steps:
- Cancel the scheduled payment run.
- Have the intended recipient of the email notification recreate the scheduled payment run.