Zuora Custom Payment Method Types API
Open Payment Method (OPM) service is a framework developed by Zuora, which allows you to integrate your custom payment method to Zuora subscription, billing, and revenue management in a dynamic and flexible manner. With the support of the OPM service, you are able to define your custom payment method types and create custom payment methods of the defined types. The custom payment method of the defined type can only be used with the custom payment gateway that you set up through the Universal Payment Connector (UPC) service. It cannot be used with the Zuora out-of-box gateway integrations such as GoCardless, Stripe, etc.You can define up to 20 custom payment method types for one tenant. Do not define your fields with the [Zuora-reserved fields](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods/C_Configure_and_manage_your_custom_payment_method_types_through_Zuora_REST_APIs#Zuora-reserved_fields).See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for more information about the OPM and UPC services.Note: You can only use the bearer token to access the "Custom Payment Method Types" API operations. Access with `apiAccessKeyId` and `apiSecretAccessKey` is not supported.
Zuora Custom Payment Method Types API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Custom Payment Method Types. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 5 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Open Payment Method (OPM) service is a framework developed by Zuora, which allows you to integrate your custom payment method to Zuora subscription, billing, and revenue managemen…
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are OpenPaymentMethodTypeRequestFields (13 properties), OpenPaymentMethodTypeResponseFields (13 properties), GETOpenPaymentMethodTypeRevisionResponse (11 properties), PUTPublishOpenPaymentMethodTypeResponse (11 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zuora 12
Other APIs Zuora publishes across the network.