---
title: "Retrieve a payment run summary"
method: GET
path: "/v1/payment-runs/{paymentRunKey}/summary"
tags: ["Payment Runs"]
---

# Retrieve a payment run summary

`GET /v1/payment-runs/{paymentRunKey}/summary`

Retrives the summary of a payment run.

## Path parameters

- `paymentRunKey` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Version` string

## Response `200`

OK

- GETPaymentRunSummaryResponse
  - `numberOfCreditBalanceAdjustments` integer — **Note:** This field is only available if you have the Credit Balance feature enabled. The number of credit balance adjustments that are successfully processed in the payment run.
  - `numberOfCreditMemos` integer — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total number of credit memos that are successfully processed in the payment run.
  - `numberOfDebitMemos` integer — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total number of debit memos that are picked up for processing in the payment run.
  - `numberOfErrorInputData` integer — The number of input data that are processed with errors.
  - `numberOfErrors` integer — The number of payments with the status of `Error` and `Processing`.
  - `numberOfInputData` integer — The total number of input data.
  - `numberOfInvoices` integer — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total number of invoices that are picked up for processing in the payment run.
  - `numberOfPayments` integer — The number of payments that are successfully processed in the payment run.
  - `numberOfProcessedInputData` integer — The number of input data that are successfully processed.
  - `numberOfReceivables` integer — The total number of receivables that are picked up for processing in the payment run. The value of this field is the sum of the value of the `numberOfInvoices` field and that of the `numberOfDebitMemos` field.
  - `numberOfUnappliedPayments` integer — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The number of unapplied payments that are successfully processed in the payment run.
  - `numberOfUnprocessedDebitMemos` integer — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The number of debit memos with remaining positive balances after the payment run is completed.
  - `numberOfUnprocessedInvoices` integer — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The number of invoices with remaining positive balances after the payment run is completed.
  - `numberOfUnprocessedReceivables` integer — The number of receivables with remaining positive balances after the payment run is completed.
  - `success` boolean — Returns `true` if the request was processed successfully.
  - `totalValues` GETPaymentRunSummaryTotalValues[] — Container for total values.
    - `totalValueOfCreditBalance` string — **Note:** This field is only available if you have the Credit Balance feature enabled. The total amount of credit balance after the payment run is completed.
    - `totalValueOfCreditMemos` string — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total amount of credit memos that are successfully processed in the payment run.
    - `totalValueOfDebitMemos` string — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total amount of debit memos that are picked up for processing in the payment run.
    - `totalValueOfErrors` string — The total amount of receivables associated with the payments with the status of `Error` and `Processing`.
    - `totalValueOfInvoices` string — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total amount of invoices that are picked up for processing in the payment run.
    - `totalValueOfPayments` string — The total amount of payments that are successfully processed in the payment run.
    - `totalValueOfReceivables` string — The total amount of receivables associated with the payment run. The value of this field is the sum of the value of the `totalValueOfInvoices` field and that of the `totalValueOfDebitMemos` field.
    - `totalValueOfUnappliedPayments` integer — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total amount of unapplied payments that are successfully processed in the payment run.
    - `totalValueOfUnprocessedDebitMemos` string — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total amount of debit memos with remaining positive balances after the payment run is completed.
    - `totalValueOfUnprocessedInvoices` string — **Note:** This field is only available if you have the Invoice Settlement feature enabled. The total amount of invoices with remaining positive balances after the payment run is completed.
    - `totalValueOfUnprocessedReceivables` string — The total amount of receivables with remaining positive balances after the payment run is completed.

---

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