Set Up the Advanced Payment Manager Feature

Knowledge Center > Collect > Advanced Payment Manager > Set Up the Advanced Payment Manager Feature

Set Up the Advanced Payment Manager Feature

Table of contents

Prerequisites

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

    The Advanced Payment Manager feature uses OAuth to authenticate to your Zuora tenant.

  • Ensure that the APM custom field 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. 

Procedure

  1. Open the settings page of the Advanced Payment Manager feature by using one of the two methods:

    • Click Setting in the top right corner on the home page.

    • Click Click to edit settings in the bottom right on the home page.

  2. Select the default time zone for all payment options. Select the same time zone as in Zuora to avoid payment errors.

  3. Select Use Configurable Payment Retry to use the retry rules defined in the Configurable Payment Retry feature, or configure the retry rules. 

    • If you select Use Configurable Payment Retry, you need to enter the API token of the Configurable Payment Retry feature. 

    • To configure the retry rules, enter the number of hours between each payment attempt, and the number of payment attempts.

  4. Configure credit and unapplied payments rules in the Credit and Unapplied Payments Rules section.

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

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

  5. 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. 
    collect_apm_doc_process.png

  6. If you want to use a custom payment gateway for a subscription, complete the following steps:

    1. Select Use custom gateway on the subscription in the Document Processing section.

    2. Click Add Custom Field to add the Payment Gateway custom field to the Subscription object. Skip this step if the custom field has already been added.

    3. Enter the payment gateway in the Payment Gateway custom field on the subscription in Zuora environment. 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 you specify values for the payment gateway custom fields.

  7. If you want Advanced Payment Manager to send a callout after a payment run, select Send callout after payment run completion in the Document Processing section, and click Configure Callout to configure the callout information. Only basic authentication credentials are supported for the callouts. 
    collect_apm_callout_config.png

  8. If you need to use a different payment method for a subscription (as opposed to the account payment method), use the Payment Method Wizard to complete the configurations. 
    payment_method_wiz.png

    • When you select an account, all active payment methods for the account will be available for selection. 

    • Changes made in this wizard are applied to your account in Zuora environment. 

    • This wizard does not add, delete, or edit payment methods. You need to perform these actions in Zuora.

    • 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 no payment method is selected, the default payment method for the account will be used.

    • 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.

    • If you want to use the default payment methods for your subscriptions, do not configure payment methods in this wizard.

  9. Click Save to save all settings.

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

Last modified

Tags

Classifications

(not set)