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

# Search refunds

`GET /v1/refunds`

Search refunds by 'from' and 'to' date. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

## Query parameters

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

## Response `200`

OK

- RefundSearchResults
  - `total` integer
  - `count` integer
  - `page` integer
  - `results` RefundDetailForSearch[]
    - `refund_id` string
    - `created_date` string
    - `amount` integer
    - `_links` RefundLinksForSearch — links for search refunds resource
      - `self` Link — A link related to a payment
        - `href` string
        - `method` string
      - `payment` Link — A link related to a payment
        - `href` string
        - `method` string
    - `status` 'submitted' | 'success' | 'error'
    - `settlement_summary` RefundSettlementSummary — A structure representing information about a settlement for refunds
      - `settled_date` string — The date that the transaction was refunded from the service's account.
  - `_links` SearchNavigationLinks — Links to navigate through pages
    - `self` Link — A link related to a payment
      - `href` string
      - `method` string
    - `first_page` Link — A link related to a payment
      - `href` string
      - `method` string
    - `last_page` Link — A link related to a payment
      - `href` string
      - `method` string
    - `prev_page` Link — A link related to a payment
      - `href` string
      - `method` string
    - `next_page` Link — A link related to a payment
      - `href` string
      - `method` string

## Other responses

- `401` — Credentials are required to access this resource
- `422` — Invalid parameters. See Public API documentation for the correct data formats
- `500` — Downstream system error

---

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