---
title: "List payment volume summary records"
method: GET
path: "/system-health/payments/volume-summary"
tags: ["Electronic Payments Health"]
---

# List payment volume summary records

`GET /system-health/payments/volume-summary`

Returns a summary of electronic payments handled by your Zuora tenant within a specified time range.

You can filter the summary by payment gateway type and payment method type.

## Query parameters

- `paymentGatewayType` string
- `paymentMethodType` string
- `startTime` string, date-time, required
- `endTime` string, date-time, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Response `200`

OK

- GetPaymentVolumeSummaryResponse
  - `data` PaymentVolumeSummaryRecord[] — List of electronic payments summary.
    - `error` integer — The count of failed payments of above `paymentGatewayType` and `paymentMethodType`.
    - `paymentGatewayType` string — The payment gateway type.
    - `paymentMethodType` string — The payment method type.
    - `success` integer — The count of successful payments of above `paymentGatewayType` and `paymentMethodType`.
    - `total` integer — The count of total payments of above `paymentGatewayType` and `paymentMethodType`.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)