---
title: "List refunds"
method: GET
path: "/v1/refunds"
tags: ["Refunds"]
---

# List refunds

`GET /v1/refunds`

**Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. 

Retrieves the information about all refunds. Two types of refunds are available, electronic refunds and external refunds.

### 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/refunds?status=Processed

- /v1/refunds?amount=4&status=Processed

- /v1/refunds?status=Processed&type=External&sort=+number

## Query parameters

- `page` integer
- `pageSize` integer
- `accountId` string
- `amount` number, double
- `createdById` string
- `createdDate` string, date-time
- `methodType` 'ACH' | 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'WireTransfer' | 'DebitCard' | 'CreditCardReferenceTransaction' | 'BankTransfer' | 'Other'
- `number` string
- `paymentId` string
- `refundDate` string, date
- `status` 'Processed' | 'Canceled' | 'Error' | 'Processing'
- `type` 'External' | 'Electronic'
- `updatedById` string
- `updatedDate` string, date-time
- `sort` string

## Headers

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

## Response `200`

OK

- GETRefundCollectionType
  - `nextPage` string, URL — URL to retrieve the next page of the response if it exists; otherwise absent.
  - `refunds` GETRefundTypewithSuccess[] — Container for refunds.
    - `accountId` string — The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.
    - `amount` number, double — The total amount of the refund.
    - `cancelledOn` string, nullable — The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format.
    - `comment` string — Comments about the refund.
    - `createdById` string — The ID of the Zuora user who created the refund.
    - `createdDate` string — The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
    - `creditMemoId` string, nullable — The ID of the credit memo that is refunded.
    - `financeInformation` object — Container for the finance information related to the refund.
      - `bankAccountAccountingCode` string, nullable — The accounting code that maps to a bank account in your accounting system.
      - `bankAccountAccountingCodeType` string, nullable — The type of the accounting code that maps to a bank account in your accounting system.
      - `transferredToAccounting` 'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore' — Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.
      - `unappliedPaymentAccountingCode` string, nullable — The accounting code for the unapplied payment.
      - `unappliedPaymentAccountingCodeType` string, nullable — The type of the accounting code for the unapplied payment.
    - `gatewayId` string, nullable — The ID of the gateway instance that processes the refund.
    - `gatewayReconciliationReason` string, nullable — The reason of gateway reconciliation.
    - `gatewayReconciliationStatus` string, nullable — The status of gateway reconciliation.
    - `gatewayResponse` string, nullable — The message returned from the payment gateway for the refund. This message is gateway-dependent.
    - `gatewayResponseCode` string, nullable — The code returned from the payment gateway for the refund. This code is gateway-dependent.
    - `gatewayState` 'MarkedForSubmission' | 'Submitted' | 'Settled' | 'NotSubmitted' | 'FailedToSettle' — The status of the refund in the gateway.
    - `id` string — The ID of the refund.
    - `markedForSubmissionOn` string, nullable — The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
    - `methodType` 'ACH' | 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'WireTransfer' | 'DebitCard' | 'CreditCardReferenceTransaction' | 'BankTransfer' | 'Other' — How an external refund was issued to a customer.
    - `number` string — The unique identification number of the refund.
    - `organizationLabel` string — The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled.
    - `paymentId` string — The ID of the payment that is refunded.
    - `paymentMethodId` string, nullable — The unique ID of the payment method that the customer used to make the refund.
    - `paymentMethodSnapshotId` string, nullable — The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.
    - `payoutId` string, nullable — The payout ID of the refund from the gateway side.
    - `reasonCode` string — A code identifying the reason for the transaction.
    - `referenceId` string, nullable — The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.
    - `refundDate` string, date — The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01.
    - `refundTransactionTime` string, nullable — The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.
    - `secondRefundReferenceId` string, nullable — The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.
    - `settledOn` string, nullable — The date and time when the refund 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, nullable — A payment gateway-specific field that maps Zuora to other gateways.
    - `softDescriptorPhone` string, nullable — A payment gateway-specific field that maps Zuora to other gateways.
    - `status` 'Processed' | 'Canceled' | 'Error' | 'Processing' — The status of the refund.
    - `submittedOn` string, nullable — The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.
    - `type` 'External' | 'Electronic' — The type of the refund.
    - `updatedById` string — The ID of the Zuora user who last updated the refund.
    - `updatedDate` string — The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
    - `IntegrationId__NS` string — ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    - `IntegrationStatus__NS` string — Status of the refund's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    - `Origin__NS` string — Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    - `SyncDate__NS` string — Date when the refund was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    - `SynctoNetSuite__NS` string — Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `success` boolean — Returns `true` if the request was processed successfully.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

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