Welcome to Zuora Product Documentation

Explore our rich library of product information

Enable and configure tenant-level payment retry rules

Learn how to enable and configure tenant-level payment retry rules to manage payment failures and retries effectively.

To enable payment retry in your tenant and configure the payment retry rules for all payments processed in your tenant:

  1. Navigate to Settings > Payments , and then click Configure Payment Retry Rules .
  2. Select Enable Payment Run retry rules to enable payment retry in your tenant and to configure your payment run retry rules.
  3. Specify the Maximum number of payment failures per Payment Method allowed by entering an integer between 1 to 100. Alternatively, you can leave this field empty but specify a value in the next step to indicate a time interval for your payment retry. The number of consecutive failures on a payment method indicates how many consecutive failed payments have been accumulated by using this payment method. It does not indicate how many failed payment retries have been attempted because the payment might be retried with different payment methods. Note that the counter for the Maximum number of payment failures per Payment Method allowed begins on April 13, 2010. This is the date the payment retry configuration became available.
  4. When collecting payment for a particular Payment Schedule Item (PSI) through the system-generated Payment Run, and if you have enabled Configure Payment Retry Rules , the payment retry rule applies to the payments collected through the Payment Schedule Item. For example:
    1. Schedule a PSI-1 on 1 January 2024 at 10:00 hours.
      • Payment P-1 is generated with ‘Error’ status, and the Payment Method failure count changes from 0 to 1. By default, the PSI-1 will reflect a ‘Pending’ status.

      • The system will create another Payment Run at 11:00 hours. No payment is generated, and the PSI-1 status will reflect ‘Error.’ This is because the Payment Method does not meet the Payment Retry rules.

    2. Without modifying the previous Account’s Payment Method max consecutive failure count, schedule a PSI-2 on 2 January 2024 at 10:00 hours.
      • No payment is generated, and PSI-2 Status will reflect ‘Error’ status as the Payment Method still does not meet the Payment Retry Rules.

  5. To specify the time interval in which you want to retry your payment, enter an integer from 1 to 1000 to indicate the number of hours that must pass after the last payment attempt before the next payment retry takes place. The number of hours must be entered in the field Do not retry payment if last payment attempt was less than __ hours(s) ago . Alternatively, you can leave this field empty but specify a value in the previous step to indicate the maximum number of payment failures allowed per payment method. Specifying a time interval in which to retry your payment run prevents a payment attempt if the last failed payment was within the last 'number' of hours. For example, if the last failed payment was at 1PM and the retry interval is 4 hours, then a Payment Run at 2PM will not attempt a payment, but a Payment Run at 6PM will retry payment.

If you want to retry "once a day," Zuora recommends that you enter 22 or 23 hours as it is possible for a payment to be attempted at the end of the payment run on one day and the beginning of the payment run the next day.

Note: After the tenant-level payment retry rules are set up, they become the default retry rules for any payment methods in your tenant, including payment methods that were created through Payment Pages 2.0 and the REST APIs. The retry rules for specific payment methods can be overridden by using the methods described in the following Configure payment retry rules for a specific payment method section.