---
title: "List all refunds"
method: GET
path: "/v2/payment/refunds"
tags: ["Payment Refunds"]
---

# List all refunds

`GET /v2/payment/refunds`

Retrieve a list of refunds with optional filtering

## Query parameters

- `page_size` integer, required
- `page_number` integer, required
- `start_time` string
- `end_time` string
- `payment_intent_id` string
- `merchant_order_id` string

## Headers

- `x-client-id` string, required

## Response `200`

List of refunds retrieved successfully

- object
  - `total_pages` integer — The total pages of available items.
  - `total_items` integer — The total counts of available items.
  - `data` PaymentRefundResponse[]
    - `payment_refund_id` string — The unique identifier for the refund
    - `payment_attempt_id` string — The ID of the payment attempt that was refunded
    - `amount` string — The amount refunded
    - `currency` string, iso-4217 — The three-letter currency code (ISO 4217)
    - `refund_status` 'INITIATED' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'REVERSAL_INITIATED' | 'REVERSAL_PROCESSING' | 'REVERSAL_SUCCEEDED' — The current status of the refund. - `INITIATED`: The refund has been initiated. - `PROCESSING`: The refund is being processed. - `SUCCEEDED`: The refund was successfully completed. - `FAILED`: The refund attempt failed. - `REVERSAL_INITIATED`: The reversal of the refund has been initiated. - `REVERSAL_PROCESSING`: The reversal of the refund is currently being processed. - `REVERSAL_SUCCEEDED`: The reversal of the refund was successfully completed.
    - `create_time` string, date/time
    - `update_time` string, date/time
    - `reason` string — The reason for the refund
    - `metadata` object — Additional metadata associated with the refund. User-defined key-value pairs.

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)