Set Up the Advanced Payment Manager Feature

Knowledge Center > Collect > Setup and Administration > Set Up the Advanced Payment Manager Feature

Set Up the Advanced Payment Manager Feature

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.

Configure Settings

Configure the subscription payment run retry frequency that will be applied to all payment runs executed by the Advanced Payment Manager feature.

  1. Navigate to feature instance and click the Settings tab.

  2. Select default time zone for all payment options.

  3. Complete Retry Rules configuration:

    1. Enter the number of payment attempts in the Number of Attempts section.

    2. Enter the number of hours between each payment attempt in the Next Retry section.

  4. Enable Process multiple documents to make a single payment for multiple billing documents.

  5. Click Save.

After completing the configuration, the following custom fields will be available in your tenant:

Object Custom Field Label Custom Field Type
Account APM Picklist
Subscription Payment Method Id Text

Configure Custom Fields

After you have installed Advanced Payment Manager, navigate to desired subscription in Zuora tenant. Two custom fields, APM and Payment Method Id, will be present and will require further configuration.

When the APM custom field is set to "True", the subscription is flagged by the Advanced Payment Manager feature to be paid by a custom payment method identified by the Payment Method Id custom field. If APM is set to "False", payments will be made by the default payment method on the account.

Use of Advanced Payment Manager functionality is not currently supported with the retry logic of Configurable Payment Retry, hence the Auto Pay flag on the account level must not be enabled.

Enter the Payment Id of the desired payment method to be used for the subscription payment. The Payment Method Id is the Zuora 32 character alphanumeric code from the Payment Method object. To obtain the Payment Method Id, the payment method must be an existing payment method on the account.

If the payment method does not exist, it must be created. Any subscription that does not have a Payment Method Id entered in the custom field, will default to the accounts default payment method. See Define Payment Methods for more information.

Obtain Payment Method Id

  1. Navigate to Reporting > Data Sources.

  2. Select a data source in the Data Source drop-down.

  3. Select the base object fields to export then select the related object fields to export.

  4. Specify any filters to apply.

  5. Specify the time frame.

  6. Select the format of the exported data.

  7. Click export.

See Generate a Data Source Export for more information.

Make a One-time Payment Run

  1. Click + New Subscription Payment Run from the landing page.

  2. Select Invoice parameters to process with payment run (Note: Only the accounts with the APM field set to "True" will be processed):

    • All Customers - Process all open invoices from all accounts.
    • Custom Query - Process invoices that meet specific criteria defined by customizable logic.
    • Filter By - Select filters to identify a specific group of invoices to be paid.
  3. Enter Target Date for payment run.

  4. Click Create.

When the payment run is executed, the Advanced Payment Manager feature completes the following steps:

  1. Collect all invoices meeting specified criteria.
  2. Segment invoices by subscription and payment method Id.
  3. Individually, make payment on the subscription with the designated payment method.

Create a Payment Run Schedule

  1. Navigate to the Payment Run Schedules tab.

  2. Select Invoice parameters to process with payment run.

    Only the accounts with the APM field set to "True" will be processed.

    • All Customers - Process all open invoices from all accounts
    • Custom Query - Process invoices that meet specific criteria defined by customizable logic
    • Filter By - Select filters to identify a specific group of invoices to be paid.
  3. Enter Date and Schedule details:

    • Select the desired time zone from the dropdown menu

    • Select the frequency of the payment run

      Minutes, Hourly, Daily, Weekly, Monthly, Yearly

      Complete specific time frame details. Start times are in military time.

    • No further action is needed for the Interval field

  4. Click Create.

Last modified

Tags

Classifications

(not set)