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

Universal Payment Connector

Overview of integrating your custom payment gateways and payment methods

Learn how to integrate custom payment gateways and methods with Zuora using Universal Payment Connector and Open Payment Method services, ensuring dynamic and flexible management of subscriptions, billing, and revenue.

Universal Payment Connector (UPC) and Open Payment Method (OPM) services are frameworks developed by Zuora, which allow you to integrate your custom payment gateway and payment method to Zuora subscription, billing, and revenue management in a dynamic and flexible manner. With the support of UPC, you are able to create and integrate your custom payment gateway. OPM offers the capabilities to create your custom payment method type and payment method.

The custom payment method of the defined type can only be used with the custom payment gateway. It cannot be used with the Zuora out-of-box gateway integration such as GoCardless, Stripe, etc. The connections of Zuora's custom payment gateway integration are expected to be synchronous.

It is recommended to leverage a 3rd party tokenization service that is usually provided by the gateway, because payment method types requiring PCI are not supported by UPC and OPM.

For payment operations and features that are supported or not supported by UPC and OPM services, see the information in the Compatibility table.

Notes for Zuora SOAP APIs

You cannot use the SOAP APIs to create, update, or delete a custom payment method. You can use the SOAP API to retrieve the following fields of a custom payment method:

  • MethodReferenceId : The identification reference of the custom payment method.

  • UserReferenceId : The identification reference of the user or customer account.

  • SubType : The identification reference indicating the subtype of the custom payment method.

  • MethodSpecificData : The JSON string containing definition data of the custom payment method.

If you have created a custom payment method through the Zuora UI or the REST APIs, you can then use your custom payment method in other SOAP APIs by specifying the PaymentMethodId field if it is available in the SOAP API. For example, you can specify the ID of your custom payment method in the PaymentMethodId field of the CRUD: Create a payment SOAP API and create a payment.

Last updated: January 12, 2026