Skip to main content

Zuora Release 2022.02.R2

Zuora

Zuora Release 2022.02.R2

Welcome to the release notes for Zuora Release 2022.02.R2. This article is a consolidated page of all release notes for the following Zuora products:

For the latest release notes of Zuora Revenue, see Zuora Revenue release notes.

We welcome and appreciate your feedback on this release notes article. Please use the Feedback button to let us know what you think about the new release notes. For more information about the recent changes to the Zuora release management process, see Attention: Changes To The Zuora Release Management Process in Zuora Community.

Release schedule

For release schedule details, see this release notification

Join Release Notifications in Zuora Community to receive timely notifications about Zuora Billing, Collect, and Central Platform.

Zuora Billing

here_black.png Customer Accounts

New REST API operations for retrieving payment methods on customer accounts

The following API operations are now available to list all the payment methods or retrieve the default payment method of a specified account:

here_black.png Invoicing and Invoice Settlement

General availability of HTML Templates for invoices

The HTML Templates feature for invoices is now generally available to all Zuora customers. With this feature, you can flexibly design and customize HTML invoice templates using an online editor. 

For more information about this feature, see Configuring HTML invoice templates.

The following new functions and enhancements are available for HTML invoice templates in this release:

Support for barcode configuration in HTML invoice templates

In HTML invoice templates, you can now configure barcodes by using a newly introduced merge field called Wp_Barcode. You can use the merge field to specify the barcode types, code text, image size, and code text position. 

The following barcode types are supported: 

  • QR_CODE
  • CODE_128
  • CODE_39
  • CODE_39_EXT
  • AUSTRALIA_POST_CUSTOMER
  • AUSTRALIA_POST_REPLY
  • AUSTRALIA_POST_ROUTING
  • AUSTRALIA_POST_REDIRECT
  • ITF_14
  • USPS_ONE_CODE

For more information, see Configure barcodes in HTML invoice templates.

Support for direct column updates to Data Table component

In the HTML invoice template editor, you can now directly update the columns for the Data Table component, including the Field, Function, Header configuration. This enhancement provides you more flexibility to keep updating a table after previewing the result.

Previously, you had to remove the existing column and add another column for updates.

Full support for multibyte characters in HTML invoice templates

HTML invoice templates now fully support multibyte characters, such as Japanese, Chinese, and Russian characters. You can now use multibyte characters as field names, table header names, and texts in HTML invoice templates. 

For more information, see Supported languages in HTML invoice templates.

Change to maximum number of uploaded images

You can now upload a maximum of 50 images to HTML invoice templates. The limit was 20 previously.

New field to specify customer account through the REST API

A new field calledaccountNumber is available in the request body of the "Create a standalone invoice" and "Create standalone invoices" API operations. Previously, only accountId was available for specifying a customer account.

here_black.png UI enhancements

Restyled settings pages

It is a continuous effort to redesign Zuora UI pages to use a new style, which provides a modern look and feel when you are interacting with the Zuora Billing application. In this release, all settings pages (such as Administration Settings or Billing Settings) are refreshed to adopt this new style, which aligns with other Billing UI pages on Sandbox environments. To switch between the old UI style and the new UI style, edit the user profile to select or clear the New Style setting. To enable or disable the new UI style across all users within a tenant, contact Zuora Global Support.

All pages in the new style on Sandbox environments will be deployed to Production environments no earlier than February 22, 2022.

up-arrow.png Back to Table of Contents

Zuora Collect

here_black.png Payments

Support for processing one-time payments with CyberSource 2.0 through Payment Pages 2.0

You can now implement Payment Pages 2.0 to support processing one-time payments with the Credit Card payment method on the CyberSource 2.0 payment gateway integration. Additional parameters can be included to process authorization amounts or invoices on the one-time Payment Pages where your users can authenticate and complete the payment.

For more information, see Implement Payment Pages 2.0 to support one-time payment flows.

Support for processing Indian-only payments with CyberSource 2.0

A new setting called Gateway Endpoint is now available on the gateway setting page for the ​​CyberSource, Payment API v2.0 gateway integration. You can use this setting to select the CyberSource endpoint that Zuora will connect to. 

If you intend to use a  gateway instance only for processing payment methods originating from India, select CyberSource India from the list. The transaction request is processed through the CyberSource Indian specific endpoint. By selecting Default, the transaction request is processed through the CyberSource standard endpoint.

For more information, see CyberSource Payment Gateway.

Enhancement in resolving transactions stuck in processing for Ayden v2 and Stripe v2

The Adyen Integration v2 and Stripe v2 have been enhanced to support idempotency to automatically resolve payments and refunds stuck in the processing status in Zuora.

Shortly after the transaction is created, the transaction will be automatically retried if it is discovered that the original request has not reached the gateway or the response has not been retrieved by Zuora. Additionally, idempotent retry will be performed hourly to retry all payments and refunds in the error or processing status.

This improvement will greatly reduce manual efforts of fixing the stuck payments and refunds while avoiding duplicate transactions.

Enhancement on Create authorization REST API

When using the Create authorization API operation to authorize a payment amount prior to capturing the payment, you can now specify either theaccountNumber or accountId field in the request body. Previously, both fields were required.

Support for associating CC Reference Transaction payment methods with accounts through REST APIs

The following API operations have been enhanced to support associating a Credit Card (CC) Reference Transaction payment method with an account:

You can either pass in the payment method ID through the hpmCreditCardPaymentMethodId field or pass in the information required for the creation of a CC Reference Transaction payment method through the paymentMethod field.

For more information about the payment gateways that support CC Reference Transaction payment methods, see Zuora Supported Payment Methods by Gateway.

Enhancements on Retrieve a payment method REST API

The response body of the "Retrieve a payment method" API operation has the following enhancements:

  • Supports returning the following payment method types:
    • Debit Card
    • Credit Card Reference Transaction
    • Custom payment methods created through the Open Payment Method service
  • Provides more information about the retrieved payment method

Gateway option field supported on PPRO gateway integration for passing in IP address

You can now submit IP information such as an IPv6 address to the PPRO (previously known as Allpago) gateway by using the  param_gwOptions_CustomerIpAddress  gateway option field. You can use this field on payment method creation through Payment Pages 2.0.

For more information, see Supported gateway option field for PPRO gateway.

Support for configuring reCAPTCHA v3 risk score threshold for Payment Pages 2.0

After the support for Google reCAPTCHA v3 is enabled, you can now configure a tenant-level risk score threshold of reCAPTCHA v3 Classic or Enterprise edition for your Payment Pages 2.0. Navigate to Payments settings > Setup Hosted Pages, and then you can specify a value in the range 0.01 - 1 for Risk Score Threshold in the Google reCAPTCHA V3 Classic/Enterprise Configuration section.

For more information, see Configure Payment Pages 2.0.

Support for passing indicator of requesting 3DS2 challenge on Braintree

Zuora's Braintree gateway integration provides support for 3DS2 through the embedded iFrame of Payment Pages 2.0. We have enhanced the Braintree gateway integration to support passing the indicator of requesting a cardholder challenge. A new setting called 3DS2 Challenge Requested is now available on the gateway setting page for the ​​Braintree gateway integration. By selecting this setting, the challengeRequested: true indicator will be passed to the gateway.

For more information, see Braintree Gateway.

New fields in Payment Method data source

The following fields are now available in the Payment Method data source:

  • Method Reference Id
  • Method Specific Data
  • Sub-Type
  • User Reference Id

For more information, see Payment Method data source.

Support for automatically creating stored credential profiles for Credit Card payment methods through Payment Pages 2.0

This feature was rolled back on March 9, 2022.

For the newly created hosted pages and the existing hosted pages without implementing the stored credential transaction support, the stored credential profiles of the recurring type are now automatically created and activated for the Credit Card payment methods, including the network transaction ID or equivalent. The implementation of a consent agreement checkbox through Z.setAgreement is no longer required. For hosted pages implemented through Direct POST to perform CITs within Zuora, specifying the fields for stored credentials is also not required.

This automatic enablement is based on the assumption that you have a process in place to capture the agreement elsewhere from your customers.

This change does not impact the existing hosted page with a consent checkbox in place.

For more information, see Configuration procedures for stored credential profiles.

here_black.png Cash Applications

Increase on limits on operations of payments and credit memos

Zuora has increased the limits on the following operations of payments and credit memos from 10,000 to 15,000 through the Zuora UI and API:

  • Applying credit memos
  • Refunding credit memos
  • Unapplying credit memos
  • Creating payments
  • Applying payments
  • Unapplying payments

When performing these operations, ensure that the total number of the invoice items and debit memo items being involved is less than 15,000. For the corresponding limits on different operations, see Known limitations in Invoice Settlement and 2022 API Changelog.

here_black.png UI enhancements

Restyled settings pages

It is a continuous effort to redesign Zuora UI pages to use a new style, which provides a modern look and feel when you are interacting with the Zuora Collect application. In this release, all settings pages (such as Administration Settings or Payment Settings) are refreshed to adopt this new style, which aligns with other Collect UI pages on Sandbox environments. To switch between the old UI style and the new UI style, edit the user profile to select or clear the New Style setting. To enable or disable the new UI style across all users within a tenant, contact Zuora Global Support.

All pages in the new style on Sandbox environments will be deployed to Production environments no earlier than February 22, 2022.

up-arrow.png Back to Table of Contents

Zuora Central Platform

here_black.png Events and Notifications

Support for sending email notifications for all events to additional email addresses

You can now send email notifications for standard or custom events to recipients’ email addresses specified in the Additional Email Addresses field on the customer account details page. Previously, emails could be sent to specified recipients only for the Invoice Posted event.

Before specifying additional email addresses, you must configure the email template for the intended event and select the Include Additional Email check box to enable the support for additional email addresses. Note that this check box is selected by default for the email template associated with the Invoice Posted event for backward compatibility.

See the following articles for more information:

here_black.png Workflow

Workflows triggered by Execute tasks contain information of the triggering Workflow

Payloads of Workflows that are triggered by the "Execute: Workflow" task now contain the following fields under theSource section:

  • Name of the triggering Workflow
  • ID of the Execute task

For more information, see Execute: Workflow.

up-arrow.png Back to Table of Contents

REST API

For a summary of REST API updates and documentation updates in the Zuora API Reference, see 2022 API Changelog

Error code changes when timestamp field values are empty in query filter

Previously, if you specified query filters that contained timestamp fields (createdDate orupdatedDate) with empty values in the request body of the following operations:

You would get an UNKNOWN_ERROR error code, which was misleading. Therefore, we have made the following changes to improve user experience.

API operation Change
query() Error code is changed from UNKOWN_ERROR to INVALID_VALUE.
Query
  • In the response body, the error code is changed from UNKOWN_ERROR to INVALID_VALUE.
  • The HTTP response code is changed from 500 to 400.

SOAP API

Current WSDL version: 116

For information about how to check your version and download the latest version. see Zuora WSDL.

SOAP API change history

For a summary of updates made to the SOAP API in recent Zuora releases, see Zuora SOAP API Version History.