---
title: "Search refunds"
method: GET
path: "/v1/refunds"
tags: ["Refunding card payments"]
---

# Search refunds

`GET /v1/refunds`

You can use this endpoint to [search refunds you’ve previously created](https://docs.payments.service.gov.uk/refunding_payments/#searching-refunds). The refunds are sorted by date, with the most recently created refunds appearing first.

## Query parameters

- `from_date` string
- `to_date` string
- `from_settled_date` string
- `to_settled_date` string
- `page` string
- `display_size` string

## Response `200`

OK - your request was successful.

- RefundSearchResults
  - `_links` SearchNavigationLinks — Links to navigate through pages of your search.
    - `first_page` Link — A link related to a payment
      - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
      - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
    - `last_page` Link — A link related to a payment
      - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
      - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
    - `next_page` Link — A link related to a payment
      - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
      - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
    - `prev_page` Link — A link related to a payment
      - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
      - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
    - `self` Link — A link related to a payment
      - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
      - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
  - `count` integer — Number of refunds on the current page of search results.
  - `page` integer — The [page of results](payments.service.gov.uk/api_reference/#pagination) you’re viewing. To view other pages, make this request again using the `page` parameter.
  - `results` RefundDetailForSearch[] — Contains the refunds matching your search criteria.
    - `_links` RefundLinksForSearch — links for search refunds resource
      - `payment` Link — A link related to a payment
        - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
        - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
      - `self` Link — A link related to a payment
        - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
        - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
    - `amount` integer — The amount refunded to the user in pence.
    - `created_date` string — The date and time you created this refund. This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:ss.SSSZ`.
    - `payment_id` string — The unique ID GOV.UK Pay automatically associated with this payment when you created it.
    - `refund_id` string — The unique ID GOV.UK Pay automatically associated with this refund when you created it.
    - `settlement_summary` RefundSettlementSummary — A structure representing information about a settlement for refunds
      - `settled_date` string — The date Stripe took the refund from a payout to your bank account. `settled_date` only appears if Stripe has taken the refund. This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DD`.
    - `status` 'submitted' | 'success' | 'error' — The [status of the refund](https://docs.payments.service.gov.uk/refunding_payments/#checking-the-status-of-a-refund-status).
  - `total` integer — Number of refunds matching your search criteria.

## Other responses

- `401` — Your API key is missing or invalid. Read more about [authenticating GOV.UK Pay API requests](https://docs.payments.service.gov.uk/api_reference/#authentication)
- `422` — Invalid parameters. See Public API documentation for the correct data formats
- `500` — Downstream system error

---

[API](https://skmtc.net/government-digital-service/apis/gov-uk-pay-api.md) · [All operations](https://skmtc.net/government-digital-service/apis/gov-uk-pay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/government-digital-service/gov-uk-pay-api/revisions/4dc2d80f453a/schema)