Welcome to Zuora Product Documentation

Explore our rich library of product information

Monitor Payment Method Updater Batch

Learn how to monitor the Payment Method Updater batch process by configuring notification emails in Zuora.

Zuora recommends that you enable the Notifications feature and configure a notification email to monitor the Payment Method Updater (PMU) batch process. After you configure the notification email for the PMU Batch Completed event, Zuora sends you an email that contains batch information when the PMU batch completes or an error occurs.

To create a notification email for the Payment Method Updater Batch Completed event, complete the following steps.

  1. In the Zuora UI, navigate to Settings > Payments, and then access the email template.
  2. Click Add new email template.
  3. Complete the basic template information.

    In the Related Event list, select Payment Method Updater Batch Completed.

  4. Complete the subject and body of the email template.

    The following table lists the merge fields that are available for the Payment Method Updater Batch Completed notification:

    Field

    Merge field tag

    Description

    Access URL

    <PMUBatch.AccessURL>

    The URL of the batch processing result page.

    Date Received

    <PMUBatch.DateReceived>

    The date on which you received the notification email for the PMU Batch Completed event.

    Date Submitted

    <PMUBatch.DateSubmitted>

    The date on which Zuora submitted the PMU batch job to the payment gateway.

    Number

    <PMUBatch.ZuoraBatchNumber>

    The batch number.

    Number of Records Changed

    <PMUBatch.NumberOfRecordsChanged>

    The number of records that Zuora updated in the batch.

    Number of Records Submitted

    <PMUBatch.NumberOfRecordsSubmitted>

    The number of records that Zuora submitted to the gateway in the batch.

    Retrieve Response Message

    <PMUBatch.RetrieveResponseMessage>

    The response message that Zuora retrieves from the gateway.

    Service Provider Name

    <PMUBatch.ServiceProviderName>

    The PMU service of the gateway.

    Status

    <PMUBatch.Status>

    The processing status of the batch. In the notification email, the value of this field is one of the following:

    • Completed

    • Error

    Submit Response Message

    <PMUBatch.SubmitResponseMessage>

    The response message that the gateway sends to indicate whether the PMU batch submission is successful.

    Updater Request ID

    <PMUBatch.UpdaterRequestID>

    The file identifier that indicates which request file the batch is included in. Zuora uses this identifier to reconcile its batch with the report file that the updater service provider generates.

    For an example of a notification email template, see Example: Notification email template for the Payment Method Updater Batch Completed event.

When the PMU batch completes or an error occurs, you receive a notification email that contains the detailed batch information. The email helps you identify the underlying issues and the actions that you must take.

Note: Zuora does not support the Notifications feature for the American Express Payment Method Updater.