Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure callout notifications for Configurable Payment Retry

Learn how to configure callout notifications to initiate the retry process for failed payments after a payment run completion.

Callout notifications are used to notify Configurable Payment Retry that a payment run has been completed and initiate the retry process for all payments that failed during the payment run.

  1. In the left navigation menu, navigate to Extension Studio > Events & Notifications, and then click the Callout Templates tab.
  2. Click + Add New Callout Template.

    For more information, see Manage callout templates.

  3. Configure the following fields in the new callout template:
    1. In the Name field, enter Completed Status or another name that indicates the notification is for CPR.
    2. From the Related Event list, select Payments > Payment > Payment Run Completion.
    3. Optional: In the Description field, enter a description.
    4. Switch Active on only when you are ready to process failed payments through CPR.
    5. In the Request Information section, configure the following fields:
      • From the HTTP Method list, select POST.

      • In the Base URL field, enter https://advanced-payment-retry---collect.apps.zuora.com/api/v1/payment_run.

    6. In the Request Body section, from the Merge Field list, select Payment Run > Payment Run ID, and then click Insert.
    7. In the Request Authentication section, configure the following fields:
      • From the Authentication Type list, select Username/Password.

      • In the Username field, enter the Zuora username associated with your tenant.

      • In the Password field, enter the API token for the CPR app instance. To get the API token, go to the Configurable Payment Retry instance, click the Settings tab, and find the API token at the top. If the token is hidden, click Show API Token.

    8. Click Save.

The callout template is saved and is available to select when you configure the notification.

Configure the notification to reflect the template settings. For more detailed information, see Configure the notification