---
title: "List payment runs"
method: GET
path: "/v1/payment-runs"
tags: ["Payment Runs"]
---

# List payment runs

`GET /v1/payment-runs`

Retrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response.

### Filtering

You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.

If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. 

Examples:

- /v1/payment-runs?status=Processed

- /v1/payment-runs?targetDate=2017-10-10&status=Pending

- /v1/payment-runs?status=Completed&sort=+updatedDate

## Query parameters

- `page` integer
- `pageSize` integer
- `createdById` string
- `createdDate` string, date-time
- `status` 'Pending' | 'Processing' | 'Completed' | 'Error' | 'Canceled'
- `targetDate` string, date
- `updatedById` string
- `updatedDate` string, date-time
- `sort` string

## Headers

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

## Response `200`

OK

- GETPaymentRunCollectionType
  - `nextPage` string — The URL for requesting the next page of the response, if it exists; otherwise absent.
  - `paymentRuns` GETPaymentRunType[] — Container for payment runs.
    - `accountId` string — The ID of the customer account associated with the payment run.
    - `applyCreditBalance` boolean — **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled. Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled.
    - `autoApplyCreditMemo` boolean — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. Whether to automatically apply a posted credit memo to one or more receivables in the payment run.
    - `autoApplyUnappliedPayment` boolean — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. Whether to automatically apply unapplied payments to one or more receivables in the payment run.
    - `batch` string — The alias name given to a batch.
    - `billCycleDay` string — The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.
    - `billingRunId` string, uuid — The ID of the bill run.
    - `collectPayment` boolean — Whether to process electronic payments during the execution of payment runs.
    - `completedOn` string, nullable — The date and time when the payment run is completed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:39:58.
    - `consolidatedPayment` boolean — **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://docs.zuora.com?resourceId=platform-payments-roles) for more information. Whether to process a single payment for all receivables that are due on an account.
    - `createdById` string — The ID of the Zuora user who created the payment run.
    - `createdDate` string — The date and time when the payment run was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
    - `currency` string — A currency defined in the web-based UI administrative settings.
    - `executedOn` string, nullable — The date and time when the payment run is executed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:30:37.
    - `id` string — The ID of the payment run.
    - `number` string — The identification number of the payment run.
    - `organizationLabels` object[] — The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled.
      - `organizationId` string — The organization ID.
      - `organizationName` string — The organization name.
    - `paymentGatewayId` string, uuid, nullable — The ID of the gateway instance that processes the payment.
    - `processPaymentWithClosedPM` boolean — **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://docs.zuora.com?resourceId=platform-payments-roles) for more information. Whether to process payments even if the default payment method is closed.
    - `runDate` string, nullable — The date and time when the scheduled payment run is to be executed for collecting payments.
    - `status` 'Pending' | 'Processing' | 'Completed' | 'Error' | 'Canceled' — The status of the created payment run.
    - `success` boolean — Returns `true` if the request was processed successfully.
    - `targetDate` string, date — The target date used to determine which receivables to be collected in the payment run.
    - `updatedById` string — The ID of the Zuora user who last updated the payment run.
    - `updatedDate` string — The date and time when the payment run was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
    - `useCustomPaymentMethods` boolean — Whether to enable payment profiles for a payment run.
  - `success` boolean — Returns `true` if the request was processed successfully.

---

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