Skip to main content

Configure the Advanced Payment Manager feature

Zuora

Configure the Advanced Payment Manager feature

Prerequisites

  • You must have installed the Advanced Payment Manager feature. See Install Zuora Collections features for more information.

  • The feature must be created by using the OAuth credential. See Verify and update OAuth credentials for more information.

  • Ensure that Account.APM is set to True for accounts using Advanced Payment Manager.

  • To use the retry rules defined in the Configurable Payment Manager feature, you must install and configure the Configurable Payment Retry feature. To avoid conflicts between the out-of-box payment runs in Zuora and the payment runs in Advanced Payment Manager, we recommend that you turn off the account-level auto-pay. This setting ensures that payment runs in the Advanced Payment Manager will be used to activate the retry logic. 

Overview

You can configure the following settings of the Advanced Payment Manager feature.

  • General settings, including the time zone, retry rules, and payment methods.
  • Settings that are related to payment rules and document processing
  • Settings for callouts that are triggered after payment runs.

After the initial configuration is completed, several custom fields are added to your tenant. See Custom fields of Collections for details.

Configure general settings

  1. In Advanced Payment Manager, navigate to Settings > General.

    collect_apm_settings_general.png
  2. Select the default time zone for all payment options in Advanced Payment Manager. We recommend that you select the same time zone as in Zuora to avoid payment errors.
  3. Configure the payment retry rules.
    • To use Configurable Payment Retry to retry the payments that failed during the payment run, you must configure a callout notification to Configurable Payment Retry. See Configure the Configurable Payment Retry feature for details about how to configure the callout and other configuration tasks for Configurable Payment Retry.  Ensure that the out-of-box payment retry is disabled.
    • To manually configure the retry rules, enter the number of hours between each payment attempt, and the number of payment attempts.
  4. If you need to configure different payment methods for different subscriptions, click Open Wizard. The Payment Method Wizard opens.
    1. Select the account that you want to configure the payment methods for. The payment methods available for the account and the list of subscriptions are loaded.
    2. Locate the subscription you want to configure in the list.
    3. Click the dropdown list in the Payment Method column for this subscription and then select the payment method for your needs. If no payment method is selected, the default payment method for the account will be used.
    4. Click Save. The configured payment methods are applied to the subscriptions.

    collect_apm_settings_wizard.png

    Notes:

    • This wizard does not add, delete, or edit payment methods. You need to perform these actions in Zuora.
    • Your changes made in the wizard are also applied to your Zuora account.
    • If the payment method configured for a subscription in Advanced Payment Manager is deleted later in Zuora, subsequent payment runs will return a payment method error.
    • If you also use the Payment Method Updater feature, the payment methods that you configure here cannot be updated by the Payment Method Updater feature. In this case, you need to manually check the payment methods that are configured here.
  5. Click Update to save the settings.

Configure payment rules and document processing settings

  1. In Advanced Payment Manager, navigate to Settings > Payment Rules.

  2. Configure credit and unapplied payments rules.

    • If Invoice Settlement is not enabled on your tenant, select whether to use account credit balance during payment runs.
      collect_apm_settings_pr2.png

    • If Invoice Settlement is enabled on your tenant, select whether to use unapplied credit memos and unapplied payments during payment runs.
      collect_apm_settings_pr.png

  3. If you want multiple invoices to be processed in one payment run, select Process Multiple Documents per Payment, if available in the Document Processing section.

  4. If you want to use a custom payment gateway for a subscription, select Use custom gateway on the subscription.
    You also need to enter the payment gateway in the Payment Gateway custom field on the subscription in Zuora. The payment gateway name must match the name shown in the payment gateway list in Zuora. If no value is specified for this field, the default payment gateway for the customer account will be used for the subscription.
    Note: If you want to use the default payment methods (account payment methods) for your subscriptions, do not specify values for the payment gateway custom fields.

  5. Click Update to save the settings.

If you want Advanced Payment Manager to send a callout after a payment run, you need to configure the callout settings.

  1. In Advanced Payment Manager, navigate to Settings > Callout.
    collect_apm_settings_callout.png
  2. Select Send callout after payment run completion, and click Configure Callout to start the callout configuration window. Only basic authentication credentials are supported for the callouts.
    collect_apm_settings_callout_config.png
  3. Complete the callout settings.
  4. Click Save, and then click Update to save the settings.

What's next?

You can now start using Advanced Payment Manager. For details, see Using the Advanced Payment Manager feature.