---
title: "List payment applications"
method: GET
path: "/object-query/payment-applications"
tags: ["Object Queries"]
---

# List payment applications

`GET /object-query/payment-applications`

Lists payment applications. You can use the query parameters to filter, expand, and sort the returned results.

## Query parameters

- `pageSize` integer
- `cursor` string
- `sort[]` string[]
- `expand[]` string[]
- `filter[]` string[]
- `fields[]` string[]
- `includeNullFields` boolean

## Headers

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

## Response `200`

OK

- object
  - `nextPage` string, nullable — A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.
  - `data` ExpandedPaymentApplication[]
    - `id` string — The unique identifier of the payment application.
    - `createdById` string — The unique identifier of the user who created the payment application.
    - `createdDate` string, date-time — The date and time when the payment application was created.
    - `updatedById` string — The unique identifier of the user who last updated the payment application.
    - `updatedDate` string, date-time — The date and time when the payment application was last updated.
    - `applyAmount` number, double — The applied amount of the payment.
    - `effectiveDate` string, date — The date when the payment application takes effect, in `yyyy-mm-dd` format. The effective date is later than or equal to the maximum effective date of the payment.
    - `paymentApplicationStatus` 'Processing' | 'Processed' | 'Cancelled' — The status of the payment application.
    - `accountId` string — The ID of the customer account associated with the payment application.
    - `paymentId` string — The unique ID of the created payment.
    - `invoiceId` string — The ID of the invoice to which the payment is applied.
    - `applicationGroupId` string — The ID of the application group to which this payment application belongs.
    - `debitMemoId` string — The ID of the debit memo to which the payment is applied.
    - `billingDocumentOwnerId` string — The ID of the billing document owner.
    - `accountReceivableAccountingCodeId` string — The accountReceivableAccountingCode of a standalone charge. **Note:** This field is available when the <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders" target="_blank">Standalone Orders</a>, <a href="https://docs.zuora.com?resourceId=ar-zuora-finance" target="_blank">Zuora Finance</a>, and <a href="https://docs.zuora.com?resourceId=billing-invoice-settlement" target="_blank">Invoice Settlement</a> features are enabled.
    - `unappliedPaymentAccountingCodeId` string — The accounting code for the unapplied payment.
    - `cashAccountingCodeId` string — The accounting code for cash payments.
    - `journalEntryId` string — The ID of the journal entry that corresponds to this transaction.
    - `payment` NestedPaymentOnExpand
      - `id` string — The unique identifier of the payment.
      - `createdById` string — The unique identifier of the user who created the payment.
      - `createdDate` string, date-time — The time that the payment gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format.
      - `updatedById` string — The unique identifier of the user who last updated the payment.
      - `updatedDate` string, date-time — The time that the payment gets updated in the system, in the `YYYY-MM-DD HH:MM:SS` format.
      - `accountId` string — The ID of the customer account that the payment is for.
      - `accountingCode` string — The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.
      - `amount` number, double — The total amount of the payment.
      - `appliedAmount` number, double — The applied amount of the payment.
      - `authTransactionId` string — The authorization transaction ID from the payment gateway.
      - `appliedCreditBalanceAmount` number — The amount of the payment to apply to a credit balance.
      - `bankIdentificationNumber` string — The first six or eight digits of the credit card or debit card used for the payment, when applicable. Use this field to <a href="https://docs.zuora.com?resourceId=payments-reconcile-payments-with-merchant-accounts" target="_blank">reconcile payments between the gateway and merchant banks</a>.
      - `cancelledOn` string, date-time — The date when the payment was canceled.
      - `comment` string, nullable — Comments about the payment.
      - `currency` string — When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.
      - `effectiveDate` string, date — The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.
      - `gatewayOrderId` string — A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.
      - `gatewayReconciliationReason` string — The reason of gateway reconciliation.
      - `gatewayReconciliationStatus` string — The status of gateway reconciliation.
      - `gatewayResponse` string — The message returned from the payment gateway for the payment. This message is gateway-dependent.
      - `gatewayResponseCode` string — The code returned from the payment gateway for the payment. This code is gateway-dependent.
      - `gatewayState` 'MarkedForSubmission' | 'Submitted' | 'Settled' | 'NotSubmitted' | 'FailedToSettle' — The status of the payment in the gateway; use for reconciliation.
      - `gatewayTransactionState` string
      - `isStandalone` boolean — Indicates whether the payment is a standalone payment. A standalone payment is a payment that is not associated with any invoice or subscription.
      - `markedForSubmissionOn` string, date-time — The date and time when a charge was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
      - `paymentMethodId` string — The unique ID of the payment method that the customer used to make the payment.
      - `paymentMethodSnapshotId` string — The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.
      - `paymentOptionId` string — ID of the paymentOption object, which describe the transactional level rules for processing payments.
      - `paymentNumber` string — The unique identification number of a payment.
      - `payoutId` string — The payout ID of the payment from the gateway side.
      - `prepayment` boolean — Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) for more information.
      - `referencedPaymentID` string — The ID of a referenced payment.
      - `referenceId` string — The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.
      - `refundAmount` number, double — The amount of the payment that is refunded.
      - `secondPaymentReferenceId` string — The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.
      - `settledOn` string, date-time — The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.
      - `softDescriptor` string — A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
      - `softDescriptorPhone` string — A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
      - `source` 'PaymentRun' | 'Import' | 'Manually' | 'API' | 'Checkout' — Indicates how the payment was created, whether through API, manually, import, payment run, or Checkout. `Checkout` is automatically assigned when a payment is created through a Hosted Payment Method (HPM) flow, such as UPI.
      - `sourceName` string — Name of the source. It can be a payment run number or a file name.
      - `status` 'Draft' | 'Processing' | 'Processed' | 'Error' | 'Canceled' | 'Posted' — The status of the payment.
      - `submittedOn` string, date-time — The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.
      - `type` 'External' | 'Electronic' — The type of the payment.
      - `transferredToAccounting` 'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore' — Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.
      - `transactionSource` 'C_Unscheduled' | 'M_Recurring' | 'M_Unscheduled' | 'M_MOTO' — Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework. - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates. - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals. - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates. - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://docs.zuora.com?resourceId=payments-stripe-gateway-integration) for more information.
      - `unappliedAmount` number — The unapplied amount of the payment.
      - `lastEmailDateTime` string — The date and time when the last email was sent to the customer for the payment.
      - `gateway` string — Name of the gateway instance that processes the payment.
      - `account` object — The account associated with the payment.
      - `paymentMethod` object — The payment method used for this payment.
      - `paymentApplications` object[] — The payment applications associated with the payment.

## Other responses

- `500` — Internal server error
- `4XX` — Invalid input

---

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