---
title: "Refunds - List"
method: POST
path: "/refunds/list"
tags: ["Refunds"]
---

# Refunds - List

`POST /refunds/list`

Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided

## Request body

- RefundListRequest, nullable — A type representing a range of time for filtering, including a mandatory start time and an optional end time.
  - `start_time` string, date-time, required — The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed
  - `end_time` string, date-time, nullable — The end time to filter payments list or to get list of filters. If not passed the default time is now
  - `payment_id` string, nullable — The identifier for the payment
  - `refund_id` string, nullable — The identifier for the refund
  - `profile_id` string, nullable — The identifier for business profile
  - `limit` integer, nullable — Limit on the number of objects to return
  - `offset` integer, nullable — The starting point within a list of objects
  - `amount_filter` AmountFilter
    - `start_amount` integer, nullable — The start amount to filter list of transactions which are greater than or equal to the start amount
    - `end_amount` integer, nullable — The end amount to filter list of transactions which are less than or equal to the end amount
  - `connector` string[], nullable — The list of connectors to filter refunds list
  - `merchant_connector_id` string[], nullable — The list of merchant connector ids to filter the refunds list for selected label
  - `currency` Currency[], nullable — The list of currencies to filter refunds list
  - `refund_status` RefundStatus[], nullable — The list of refund statuses to filter refunds list

## Response `200`

List of refunds

- RefundListResponse
  - `count` integer, required — The number of refunds included in the list
  - `total_count` integer, required — The total number of refunds in the list
  - `data` RefundResponse[], required — The List of refund response object
    - `refund_id` string, required — Unique Identifier for the refund
    - `payment_id` string, required — The payment id against which refund is initiated
    - `amount` integer, required — The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc
    - `currency` string, required — The three-letter ISO currency code
    - `status` 'succeeded' | 'failed' | 'pending' | 'review', required — The status for refunds
    - `reason` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive
    - `metadata` object, nullable — You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object
    - `error_message` string, nullable — The error message
    - `error_code` string, nullable — The code for the error
    - `unified_code` string, nullable — Error code unified across the connectors is received here if there was an error while calling connector
    - `unified_message` string, nullable — Error message unified across the connectors is received here if there was an error while calling connector
    - `created_at` string, date-time, nullable — The timestamp at which refund is created
    - `updated_at` string, date-time, nullable — The timestamp at which refund is updated
    - `connector` string, required — The connector used for the refund and the corresponding payment
    - `profile_id` string, nullable — The id of business profile for this refund
    - `merchant_connector_id` string, nullable — The merchant_connector_id of the processor through which this payment went through
    - `split_refunds` union — Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.
      - object
        - `stripe_split_refund` StripeSplitRefundRequest, required — Charge specific fields for controlling the revert of funds from either platform or connected account for Stripe. Check sub-fields for more details.
          - `revert_platform_fee` boolean, nullable — Toggle for reverting the application fee that was collected for the payment. If set to false, the funds are pulled from the destination account.
          - `revert_transfer` boolean, nullable — Toggle for reverting the transfer that was made during the charge. If set to false, the funds are pulled from the main platform's account.
      - object
        - `adyen_split_refund` AdyenSplitData, required — Fee information for Split Payments to be charged on the payment being collected for Adyen
          - `store` string, nullable — The store identifier
          - `split_items` AdyenSplitItem[], required — Data for the split items
            - `amount` integer, required — The amount of the split item
            - `split_type` 'BalanceAccount' | 'AcquiringFees' | 'PaymentFee' | 'AdyenFees' | 'AdyenCommission' | 'AdyenMarkup' | 'Interchange' | 'SchemeFee' | 'Commission' | 'TopUp' | 'Vat', required
            - `account` string, nullable — The unique identifier of the account to which the split amount is allocated.
            - `reference` string, required — Unique Identifier for the split item
            - `description` string, nullable — Description for the part of the payment that will be allocated to the specified account.
      - object
        - `xendit_split_refund` XenditSplitSubMerchantData, required — Fee information to be charged on the payment being collected for sub-merchant via xendit
          - `for_user_id` string, required — The sub-account user-id that you want to make this transaction for.
    - `issuer_error_code` string, nullable — Error code received from the issuer in case of failed refunds
    - `issuer_error_message` string, nullable — Error message received from the issuer in case of failed refunds
    - `raw_connector_response` string, nullable — Contains whole connector response
    - `connector_refund_id` string, nullable — A unique identifier for a payment provided by the connector

---

[API](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0.md) · [All operations](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hyperswitch/dynamic-routing-openapi-3-0/revisions/8fbf69ab2597/schema)