Retrieve a payment run summary

Retrives the summary of a payment run.

Request
path Parameters
paymentRunKey
required
string

The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Responses
200
get/v1/payment-runs/{paymentRunKey}/summary
Request samples 
Response samples 
application/json
{
  • "numberOfCreditBalanceAdjustments": 0,
  • "numberOfCreditMemos": 1,
  • "numberOfDebitMemos": 1,
  • "numberOfErrors": 0,
  • "numberOfInvoices": 0,
  • "numberOfPayments": 1,
  • "numberOfReceivables": 1,
  • "numberOfUnappliedPayments": 1,
  • "numberOfUnprocessedDebitMemos": 0,
  • "numberOfUnprocessedInvoices": 0,
  • "numberOfUnprocessedReceivables": 0,
  • "success": true,
  • "totalValues": [
    ]
}