List payment runs

GET

/v1/payment-runs

GET

/v1/payment-runs

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.payment_runs.get_payment_runs()

200response

{
  "nextPage": "/payment-runs?page=2",
  "paymentRuns": [
    {
      "applyCreditBalance": false,
      "collectPayment": true,
      "completedOn": "2017-12-28 13:00:00",
      "consolidatedPayment": false,
      "createdById": "2c92c0f956bc8fcb0156f8eee04b4d54",
      "createdDate": "2017-12-27 13:00:00",
      "executedOn": "2017-12-28 13:00:00",
      "id": "2c92c0856078bbcb016096576ccb75ca",
      "number": "PR-00002121",
      "processPaymentWithClosedPM": false,
      "status": "Completed",
      "targetDate": "2017-12-28",
      "updatedById": "2c92c0f956bc8fcb0156f8eee04b4d54",
      "updatedDate": "2017-12-28 13:00:00"
    }
  ],
  "success": true
}

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

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Query parameters

pageintegerOptional>=1Defaults to 1

The index number of the page that you want to retrieve. This parameter is dependent on pageSize. You must set pageSize before specifying page. For example, if you set pageSize to 20 and page to 2, the 21st to 40th records are returned in the response.

pageSizeintegerOptional<=40Defaults to 20

The number of records returned per page in the response.

createdByIdstringOptional

This parameter filters the response based on the createdById field.

createdDatedatetimeOptional

This parameter filters the response based on the createdDate field.

statusenumOptional

This parameter filters the response based on the status field.

Allowed values:

targetDatedateOptional

This parameter filters the response based on the targetDate field.

updatedByIdstringOptional

This parameter filters the response based on the updatedById field.

updatedDatedatetimeOptional

This parameter filters the response based on the updatedDate field.

sortstringOptional

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the following form:

operator field_name

You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: operator field_name, operator field_name

operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.

The - operator indicates an ascending order.
The + operator indicates a descending order.

By default, the response data is displayed in descending order by payment run number.

field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below:

targetDate
status
createdDate
createdById
updatedDate
updatedById

Examples:

/v1/payment-runs?sort=+createdDate
/v1/payment-runs?status=Processing&sort=-createdById,+targetDate

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

nextPagestringOptional

The URL for requesting the next page of the response, if it exists; otherwise absent.

paymentRunslist of objectsOptional

Container for payment runs.

successbooleanOptional

Returns true if the request was processed successfully.