home

Zuora Payments

Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableZuora AIRelease NotesBasicsEntitlementsSupport and policies
Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableZuora AIRelease NotesBasicsEntitlementsSupport and policies

Welcome to Zuora Product Documentation

Explore our rich library of product information

Show Contents

Show Page Sections

thumbnailZuora Payments

Modernized Zuora Payments

Quickstart guide

Learn how to set up a sample card payment flow using Modernized Zuora Payments, from connecting a test provider to configuring routing and checkout.

Note:

This feature is available only with the Modernized Zuora Payments add-on SKU.

To access the Early Adopter program, contact your Zuora account representative.

This guide uses one payment method and one test payment provider connection. You can expand the configuration by adding more providers, payment methods, routing conditions, or checkout configurations.

Sample scenario

The example configures a flow for accepting card payments from customers in the United States:

  • Payment method: Card.
  • Transaction country: United States.
  • Transaction currency: USD.
  • Payment amount for testing: 100 USD.
  • Payment provider: Zuora Test Payment Gateway.
  • Checkout fields: First name, last name, email, and billing address.
  • Routing behavior: Send card transactions matching these conditions to the connected provider.

The same scenario values apply throughout the guide. Use the United States and USD when you define the route condition, configure the checkout display condition, preview checkout, and simulate the route.

Before you begin

Make sure that:

  • Modernized Zuora Payments is enabled for your tenant.
  • You have permission to configure connections, routing, and checkout.
  • You have the credentials and configuration values required by your payment provider.
  • You know which tenant accounts the connection should apply to.
  • You have selected the payment method that you want to offer to customers.
  • You are working in a test environment and have access to test credentials.

Quickstart flow

Complete the setup in the following order:

  1. Connect a payment provider and payment method.
  2. Create and publish a transaction routing rule.
  3. Configure and publish the checkout experience.

Connect to a payment provider

For the sample scenario, set up a Zuora Test payment Gateway instance for a tenant account that you use to test the flow.

  1. In the left navigation pane, navigate to Zuora Payments > Connections.
  2. On the Explore tab, search for the Zuora Test Payment Gateway.
  3. Click Connect.
  4. Enter Test payment gateway as the connection name. Leave other settings blank.
  5. Optional: Configure cost information for successful and unsuccessful payments. Smart Routing can use this information later.
  6. Click Save.

Create and publish a routing rule

For the sample scenario, configure a route that matches card payments from the United States in USD and sends them to the test payment provider connection.

  1. Navigate to Zuora Payments > Routing
  2. Select the Card payment method, and click Set up or View.
  3. Click Create new route.
  4. Enter a name for the route, such as Basic payment route, and click Save.
  5. Click Add new condition and add a name and description for the condition. For example, specify USD transactions as the name and Sends USD transactions to test gateway as the description.
  6. Configure the condition for the sample scenario as follows:
    1. Select Country field and select United States from the drop-down field.
    2. Select Currency and amount field and select US Dollar from the drop-down field.
    Available conditions vary by payment method and can include country, currency, amount, payment origin, and other transaction attributes.
  7. Click Save.
  8. Add the payment provider connection as a route step:
    1. Click the arrow next to the condition.
    2. Click Add step.
    3. Select the provider connection, Zuora Test Payment Gateway.
    4. Click Select.
  9. Click Publish.

Test the route

  1. On the routing configuration page, click Simulate.
  2. On the routing simulation page, enter the following transaction values:
    • Transaction type: Purchase.
    • Card type and card brand: Enter values supported by your test provider.
    • Country: United States.
    • Currency: USD.
    • Amount: 100 USD.
    • Issuer country: Enter a value supported by your test scenario.
    • Card BIN number: Enter a test bank identification number (BIN) supported by your payment provider.
  3. Click Start testing.
  4. Review the result for each route component.
  5. Verify that the transaction follows the expected connection and outcome path.

If the route does not produce the expected result, review the route conditions, connection status, and published route version.

Configure the checkout experience

For this example, make Card available for orders from the United States that use USD. Collect the following customer information: first name, last name, email address, and billing address.

  1. Navigate to Zuora Payments > Checkout.
  2. In the Payment method settings section, locate the payment method that you connected and routed.
  3. Activate Card if it is not activated.
  4. Set the position of Card in the order in which you want it displayed.
  5. Click the More actions menu of the Card payment method. and select Set Conditions.
    1. Click Add new condition.
    2. Optional: Add a display condition for orders from United States that use USD. Complete the configuration as follows if you want to hide cards in countries other than the US.

      Order country

      United States

      Order currency & amount

      One of the following: US Dollar

  6. Click the More actions menu of the Card payment method. and select Set required fields. Toggle on the following fields to make them mandatory, then click Save changes:

    • First name

    • Last name

    • Email

    • Address configuration, then select Billing Address only

  7. In the preview panel, review and validate the payment form preview by specifying the following values in the filters above the panel:

    • Country: United States

    • Currency: USD

    • Amount: 100

  8. Click Publish.

Test the checkout configuration

Learn how to verify checkout fields, styling, validation, publication, and payment routing.

  1. Navigate to Zuora Payments > Checkout
  2. In the preview filters, set Country to United States, Currency to USD, and Amount to 100.
  3. Verify that Card is displayed for the selected transaction values.
  4. In the preview, select Card.
  5. Verify that the following fields are displayed:
    • First name
    • Email
    • Last name
    • Billing address
  6. Leave a required field blank and verify that a validation message is displayed.
  7. (Optional) Verify that the styling changes are displayed in the preview.
  8. After you verify the configuration, click Publish.

Last updated: October 31, 2026