Sign in
Payment Runs

Retrieve a payment run summary

Retrives the summary of a payment run.

get/v1/payment-runs/{paymentRunKey}/summary

Path parameters

paymentRunKeystring required

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

Headers

Accept-Encodingstring

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-Encodingstring

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-Track-Idstring

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 (').

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

numberOfCreditBalanceAdjustmentsinteger

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.

numberOfCreditMemosinteger

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.

numberOfDebitMemosinteger

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.

numberOfErrorInputDatainteger

The number of input data that are processed with errors.

numberOfErrorsinteger

The number of payments with the status of Error and Processing.

numberOfInputDatainteger

The total number of input data.

numberOfInvoicesinteger

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.

numberOfPaymentsinteger

The number of payments that are successfully processed in the payment run.

numberOfProcessedInputDatainteger

The number of input data that are successfully processed.

numberOfReceivablesinteger

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.

numberOfUnappliedPaymentsinteger

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.

numberOfUnprocessedDebitMemosinteger

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.

numberOfUnprocessedInvoicesinteger

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.

numberOfUnprocessedReceivablesinteger

The number of receivables with remaining positive balances after the payment run is completed.

successboolean

Returns true if the request was processed successfully.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.