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

# List refunds

`GET /refunds`

Use to see where refunded money actually went and whether it has settled. Filter by invoice_ids to get every settlement row for one invoice.

## Query parameters

- `invoice_ids` string[]
- `payment_ids` string[]
- `credit_note_ids` string[]
- `refund_statuses` string[]
- `refund_destinations` string[]
- `gateway` string
- `only_settled` boolean
- `limit` integer
- `offset` integer

## Response `200`

OK

- ListRefundsResponse
  - `items` RefundResponse[]
    - `amount` string
    - `attempt` integer
    - `cancelled_at` string, date-time
    - `created_at` string, date-time
    - `created_by` string
    - `credit_note_id` string
    - `currency` string
    - `environment_id` string
    - `failed_at` string, date-time
    - `failure_reason` string
    - `gateway_idempotency_token` string
    - `gateway_metadata` object
    - `gateway_refund_id` string
    - `gateway_tracking_id` string
    - `id` string
    - `idempotency_key` string
    - `initiated_at` string, date-time
    - `invoice_id` string
    - `metadata` TypesMetadata
    - `payment_gateway` string
    - `payment_id` string
    - `refund_destination` 'GATEWAY' | 'WALLET' | 'OUT_OF_BAND'
    - `refund_destination_id` string
    - `refund_reason` 'DUPLICATE' | 'FRAUDULENT' | 'REQUESTED_BY_CUSTOMER' | 'ORDER_CHANGE' | 'SERVICE_ISSUE' | 'OTHER'
    - `refund_status` 'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED'
    - `settled_amount` string
    - `status` 'published' | 'deleted' | 'archived'
    - `succeeded_at` string, date-time
    - `tenant_id` string
    - `updated_at` string, date-time
    - `updated_by` string
  - `pagination` TypesPaginationResponse
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `500` — Server error

## Changes

- **2026-09-03** `e36fe54e0efb` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/flexprice/apis/flexprice-api/changes/refunds/get.md)

---

[API](https://skmtc.dev/flexprice/apis/flexprice-api.md) · [All operations](https://skmtc.dev/flexprice/apis/flexprice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flexprice/apis/flexprice-api/revisions/19bac1b92501?raw)
