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

# List refunds

`GET /refunds`

Returns a paginated list of refunds, with optional filtering by payment, company, user, and creation date.

Required permissions:
 - `payment:basic:read`

## Query parameters

- `after` string, nullable — Returns the elements in the list that come after the specified cursor.
- `before` string, nullable — Returns the elements in the list that come before the specified cursor.
- `first` integer, nullable — Returns the first _n_ elements from the list.
- `last` integer, nullable — Returns the last _n_ elements from the list.
- `payment_id` string, nullable — Filter refunds to only those associated with this specific payment.
- `company_id` string, nullable — Filter refunds to only those belonging to this company.
- `user_id` string, nullable — Filter refunds to only those associated with this specific user.
- `direction` 'asc' | 'desc' — The direction of the sort.
- `created_before` string, date-time, nullable — Only return refunds created before this timestamp.
- `created_after` string, date-time, nullable — Only return refunds created after this timestamp.

## Response `200`

A successful response

- object — The connection type for Refund.
  - `data` RefundListItem[], required — A list of nodes.
    - `amount` number, required — The refunded amount as a decimal in the specified currency, such as 10.43 for $10.43 USD.
    - `created_at` string, date-time, required — The datetime the refund was created.
    - `currency` 'usd' | 'sgd' | 'inr' | 'aud' | 'brl' | 'cad' | 'dkk' | 'eur' | 'nok' | 'gbp' | 'sek' | 'chf' | 'hkd' | 'huf' | 'jpy' | 'mxn' | 'myr' | 'pln' | 'czk' | 'nzd' | 'aed' | 'eth' | 'ape' | 'cop' | 'ron' | 'thb' | 'bgn' | 'idr' | 'dop' | 'php' | 'try' | 'krw' | 'twd' | 'vnd' | 'pkr' | 'clp' | 'uyu' | 'ars' | 'zar' | 'dzd' | 'tnd' | 'mad' | 'kes' | 'kwd' | 'jod' | 'all' | 'xcd' | 'amd' | 'bsd' | 'bhd' | 'bob' | 'bam' | 'khr' | 'crc' | 'xof' | 'egp' | 'etb' | 'gmd' | 'ghs' | 'gtq' | 'gyd' | 'ils' | 'jmd' | 'mop' | 'mga' | 'mur' | 'mdl' | 'mnt' | 'nad' | 'ngn' | 'mkd' | 'omr' | 'pyg' | 'pen' | 'qar' | 'rwf' | 'sar' | 'rsd' | 'lkr' | 'tzs' | 'ttd' | 'uzs' | 'rub' | 'btc' | 'cny' | 'usdt' | 'kzt' | 'awg' | 'whop_usd' | 'xau', required — The available currencies on the platform
    - `id` string, required — The unique identifier for the refund.
    - `payment` object, nullable, required — The original payment that this refund was issued against. Null if the payment is no longer available.
      - `id` string, required — The unique identifier for the payment.
    - `provider` 'stripe' | 'coinbase' | 'paypal' | 'apple' | 'sezzle' | 'splitit' | 'platform_balance' | 'multi_psp' | 'adyen' | 'claritypay' | 'checkout_dot_com' | 'airwallex' | 'coinflow' | 'sequra' | 'dlocal' | 'masspay' | 'braintree', required — The different payment providers.
    - `provider_created_at` string, date-time, nullable, required — The timestamp when the refund was created in the payment provider's system. Null if not available from the provider.
    - `reference_status` 'available' | 'pending' | 'unavailable', required — The status of the refund reference.
    - `reference_type` 'acquirer_reference_number' | 'retrieval_reference_number' | 'system_trace_audit_number', required — The type of refund reference that was made available by the payment provider.
    - `reference_value` string, nullable, required — The tracking reference value from the payment processor, used to trace the refund through banking networks. Null if no reference was provided.
    - `status` 'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled', required — The different statuses for a Refund object
  - `page_info` PageInfo, required — Information about pagination in a connection.
    - `end_cursor` string, nullable, required — When paginating forwards, the cursor to continue.
    - `has_next_page` boolean, required — When paginating forwards, are there more items?
    - `has_previous_page` boolean, required — When paginating backwards, are there more items?
    - `start_cursor` string, nullable, required — When paginating backwards, the cursor to continue.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `422` — Verification required
- `429` — Too many requests
- `500` — Internal server error

---

[API](https://skmtc.net/whop/apis/whop-api.md) · [All operations](https://skmtc.net/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whop/whop-api/versions/db0883548bc5/schema)