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

# List payment system health records

`GET /system-health/payments/details`

Returns System Health Electronic Payments records that are generated by your Zuora tenant within a specified time range.


You can filter the failure records by one or multiple of the following fields:
  - payment gateway type
  - payment method type
  - payment status
  - payment gateway response code
  - currency

## Query parameters

- `page` integer
- `pageSize` integer
- `paymentGatewayType` string
- `paymentMethodType` string
- `paymentStatus` string
- `paymentGatewayResponseCode` string
- `currency` string
- `sort` 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

- GetPaymentRecordsResponse
  - `data` PaymentRecordsDetails[] — List of Electronic Payment Records
    - `payment_method_type` string — The type of payment method used for the transaction, such as credit card or bank transfer.
    - `amount` number — The total amount of the transaction.
    - `payment_status` 'Success' | 'Error' — The current status of the payment transaction.
    - `source_type` string — The source from which the payment transaction originated, such as a payment run or manual entry.
    - `payment_gateway_response_code` string — The response code returned by the payment gateway.
    - `payment_gateway_response_msg` string — The response message returned by the payment gateway, providing additional details about the transaction status.
    - `request_duration` integer — The time taken to process the payment request, in milliseconds.
    - `payment_number` string — A unique identifier for the payment transaction.
    - `payment_id` string — A unique identifier assigned to the payment in the system.
    - `zuora_response_code` string — The response code returned by Zuora, indicating the status of the transaction.
    - `currency` string — The currency in which the transaction was processed.
    - `source_id` string — A unique identifier for the source entity that initiated the payment.
    - `payment_gateway_type` string — The type of payment gateway used to process the transaction.
    - `payment_date` string, date — The date the payment transaction was processed.
  - `nextPage` string, url — URL to the next page of results for pagination.

## 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)