home

Zuora Payments

Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies
Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies

Welcome to Zuora Product Documentation

Explore our rich library of product information

Show Contents

thumbnailZuora Payments

Configure Configurable Payment Retry

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.

To set up a callout notification, configure the following settings:

  • Callout template - configure a new template and set the related event to Payment Run Completion under Payments .

  • Notifications - configure the notification to reflect the template settings.

To configure the callout template, perform the following actions:

To configure the notification, perform the following actions:

  1. Navigate to Extension Studio > Events & Notifications in the left navigation menu and click the Callout Templates tab.
  2. Click + Add New Callout Template. For more information on adding a new callout template, see Manage callout templates .
  3. Make sure to configure the following details in the new callout template:
    1. Name - Enter “Completed Status” or a name indicating this notification is for CPR.
    2. Related Event - Select Payments > Payment > Payment Run Completion .
    3. Description - Enter a description (optional).
    4. Active - Enable the notification (only when you are ready to process failed payments through CPR).
    5. In the Request Information section,

      1. HTTP Method - Select POST.

      2. Base URL - Enter https://advanced-payment-retry---collect.apps.zuora.com/api/v1/payment_run .

    6. In the Request Body section,

      1. Merge Field : Select Payment Run > Payment Run ID > Insert .

    7. In the Request Authentication section,

      1. Authentication Type : Select Username/Password .

      2. Username - Enter the Zuora username associated with your tenant.

      3. Password - Enter the CPR app instance API Token. To obtain your API token, navigate to the Configurable Payment Retry instance, click the Settings tab, and find the API Token at the top. If it is not visible, click Show API Token .

    8. Save the template.
  4. Navigate to Extension Studio > Events & Notifications in the left navigation menu.
  5. Click + Add New Notification .
  6. Create the notification step-by-step with the following information: For more information, see Create a notification .

    Configuration details

    Step 1: Define Trigger

    Click On An Event Occurrence .

    Step 2: Select Event

    Select Payments > Payment > 2140 - Payment Run Completion .

    Step 3: Set Filters

    Select Completed for Payment Run Result Status .

    Step 4: Set Delivery Options

    From the Delivered By Callout list, select the callout template you just created.

    Step 5: Define Target Accounts

    Select a communication profile.

    For more information, see Communication profiles .

    Step 6: Finalize Notification Details

    Specify the following basic information:

    • Name : Enter “Completed Status” or a name indicating this notification is for CPR.

    • Description : Enter a description (optional).

    • Active : Enable the notification (only when ready to process failed payments through CPR).

    Step 7: Review Notification

    Review the notification settings.

  7. Click Done .

Last updated: November 30, 2025