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

# Retrieve payment run data

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

Retrieves payment run data and the processing result with details, if the `data` field was specified in the Create payment run operation.

## Path parameters

- `paymentRunKey` string, required

## Headers

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

## Response `200`

OK

- GETPaymentRunDataArrayResponse
  - `data` GETPaymentRunDataElementResponse[] — Container for payment run data. Each element in the array is a record processed by the payment run.
    - `accountId` string — The customer account ID specified in the `data` field when creating the payment run.
    - `accountNumber` string — The customer account number specified in the `data` field when creating the payment run.
    - `amount` number — The amount specified in the `data` field when creating the payment run. `null` is returned if it was not specified.
    - `amountCollected` number — The amount that is collected.
    - `amountToCollect` number — The amount to be collected.
    - `comment` string, nullable — The comment specified in the `data` field when creating the payment run. `null` is returned if it was not specified.
    - `currency` string — This field is only available if support for standalone payments is enabled. The currency of the standalone payment. The currency of the standalone payment can be different from the payment currency defined in the customer account settings.
    - `documentId` string — The billing document ID specified in the `data` field when creating the payment run. `null` is returned if it was not specified.
    - `documentNumber` string — The billing document number specified in the `data` field when creating the payment run. `null` is returned if it was not specified.
    - `documentType` 'Invoice' | 'DebitMemo' — The billing document type specified in the `data` field when creating the payment run. `null` is returned if it was not specified.
    - `errorCode` string — The error code of the response.
    - `errorMessage` string — The detailed information of the error response.
    - `paymentGatewayId` string, nullable — The payment gateway ID specified in the `data` field when creating the payment run. `null` is returned if it was not specified.
    - `paymentMethodId` string — The payment method ID specified in the `data` field when creating the payment run. `null` is returned if it was not specified.
    - `result` 'Processed' | 'Error' — Indicates whether the data is processed successfully or not.
    - `standalone` boolean — This field is only available if the support for standalone payment is enabled. The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.
    - `transactions` GETPaymentRunDataTransactionElementResponse[] — Container for transactions that apply to the current request. Each element contains an array of the settlement/payment applied to the record.
      - `amount` number — The total amount of the newly generated payment. **Note:** This field is only available if `type` is `Payment`.
      - `appliedAmount` number — The amount allocated to this data record.
      - `errorCode` string — The error code of the response. **Note:** This field is only available if `type` is `Payment`.
      - `errorMessage` string — The detailed information of the error response. **Note:** This field is only available if `type` is `Payment`.
      - `id` string — The ID of the current transaction.
      - `status` 'Processed' | 'Processing' | 'Error' — The status of the newly generated payment. **Note:** This field is only available if `type` is `Payment`.
      - `type` 'Payment' | 'CreditMemo' | 'UnappliedPayment' | 'CreditBalanceAdjustment' — The type of the current transaction.
  - `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)