Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Electronic Payments Health API

Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near real time. It enables you to view all the electronic payments in your Zuora tenant within the last 30 days. For more information, see Electronic Payments dashboard.

Zuora Electronic Payments Health API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Electronic Payments Health. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

1 operations 1 paths 3 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Electronic Payments Health 1

Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near r…

GET
/system-health/payments/volume-summary
List payment volume summary records
GET_SystemHealthPaymentVolumeSummary 10 params → 200400

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SystemHealthErrorResponse (5 properties), GetPaymentVolumeSummaryResponse (1 property). Each schema is shown below with its type and property counts.

SystemHealthErrorResponse
object
5 properties
PaymentVolumeSummaryRecord
A volume summary record.
GetPaymentVolumeSummaryResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-electronic-payments-health-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API