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

# List refunds

`GET /v1/refunds/`

List refunds

**Required scope: `business/orders:read`**

## Query parameters

- `created_at__gte` string, date-time, nullable — The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `created_at__lte` string, date-time, nullable — The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `updated_at__gte` string, date-time, nullable — The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `updated_at__lte` string, date-time, nullable — The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `cursor` string, nullable — A pagination cursor from where results should start being fetched.
- `limit` integer — The maximum number of results to return.
- `status` RefundStatus[], nullable — A list of statuses to filter on.

## Response `200`

Successful Response

- PaginatedResponseRefund
  - `data` Refund[], required — A list of paginated entities.
    - `id` string, required — The unique identifier of the refund.
    - `client_transaction_id` string, nullable, required — The identifier provided when creating the transaction via the SDK.
    - `display_name` string, required — A human-friendly label for the refund.
    - `receipt_number` string, required — The receipt number of the refund.
    - `payment_id` string, required — A reference to the original payment.
    - `order_id` string, nullable, required — A reference to the refund order.
    - `staff_id` string, nullable — The unique identifier of the staff member who processed the refund. Matches the `id` returned by the Staff API. `null` when no staff member is associated with the refund.
    - `original_order_id` string, nullable, required — A reference to the original order.
    - `order_number` string, nullable, required — A human-friendly identifier for the refund order.
    - `original_order_number` string, nullable, required — A human-friendly identifier for the original order.
    - `created_at` string, date-time, required — The refund creation date and time in ISO 8601 format.
    - `updated_at` string, date-time, nullable, required — The date and time the refund was last modified in ISO 8601 format.
    - `currency` string, required — The currency code in ISO 4217 format.
    - `note` string, nullable, required — An optional note attached to the refund.
    - `total_amount` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
      - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
      - `currency` string, required — The currency code in ISO 4217 format.
    - `status` 'approved' | 'failed' | 'pending' | 'rejected', required
    - `processing_fees` Fee[], required — The transaction fees that have been charged against the refund.
      - `type` 'initial', required
      - `amount` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
        - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
        - `currency` string, required — The currency code in ISO 4217 format.
    - `processed_at` string, date-time, nullable, required — The date and time the refund was processed in ISO 8601 format.
    - `payment_method` 'card' | 'cash' | 'instant_eft' | 'gift_voucher' | 'other', required
    - `refunded_processing_fees` Fee[], required — The transaction fees that have been refunded.
      - `type` 'initial', required
      - `amount` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
        - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
        - `currency` string, required — The currency code in ISO 4217 format.
    - `refund_type` 'auth_reversal' | 'credit_return' | 'other', required
  - `next_cursor` string, nullable, required — A pagination cursor that can be used to retrieve the next set of results.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

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