Refunding card payments

Search refunds

You can use this endpoint to search refunds you’ve previously created. The refunds are sorted by date, with the most recently created refunds appearing first.

get/v1/refunds

Request

Base URL
https://publicapi.payments.service.gov.uk
URL
https://publicapi.payments.service.gov.uk/v1/refunds
Auth
HTTP bearer

Query parameters

from_datestring

Returns refunds created on or after the from_date. Date and time must use Coordinated Universal Time (UTC) and ISO 8601 format to second-level accuracy - YYYY-MM-DDThh:mm:ssZ.

to_datestring

Returns refunds created before the to_date. Date and time must use Coordinated Universal Time (UTC) and ISO 8601 format to second-level accuracy - YYYY-MM-DDThh:mm:ssZ.

from_settled_datestring

Returns refunds settled on or after the from_settled_date value. You can only use from_settled_date if your payment service provider is Stripe. Date must use ISO 8601 format to date-level accuracy - YYYY-MM-DD. Refunds are settled when Stripe takes the refund from your account balance.

to_settled_datestring

Returns refunds settled before the to_settled_date value. You can only use to_settled_date if your payment service provider is Stripe. Date must use ISO 8601 format to date-level accuracy - YYYY-MM-DD. Refunds are settled when Stripe takes the refund from your account balance.

pagestring

Returns a specific page of results. Defaults to 1.

display_sizestring

The number of refunds returned per results page. Defaults to 500. Maximum value is 500.

Response

OK - your request was successful.

countinteger

Number of refunds on the current page of search results.

pageinteger

The page of results you’re viewing. To view other pages, make this request again using the page parameter.

totalinteger

Number of refunds matching your search criteria.

Example response

{
  "_links": {
    "first_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "last_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "next_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "prev_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  },
  "count": 20,
  "page": 1,
  "results": [
    {
      "_links": {
        "payment": {
          "href": "https://an.example.link/from/payment/platform",
          "method": "GET"
        },
        "self": {
          "href": "https://an.example.link/from/payment/platform",
          "method": "GET"
        }
      },
      "amount": 120,
      "created_date": "2017-01-10T16:52:07.855Z",
      "payment_id": "hu20sqlact5260q2nanm0q8u93",
      "refund_id": "act4c33g40j3edfmi8jknab84x",
      "settlement_summary": {
        "settled_date": "2016-01-21"
      },
      "status": "success"
    }
  ],
  "total": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.