---
title: "Submit a refund for a payment"
method: POST
path: "/v1/payments/{paymentId}/refunds"
tags: ["Refunding card payments"]
---

# Submit a refund for a payment

`POST /v1/payments/{paymentId}/refunds`

Return issued refund information. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

## Path parameters

- `paymentId` string, required

## Request body

- PaymentRefundRequest — The Payment Refund Request Payload
  - `amount` integer, required — Amount in pence. Can't be more than the available amount for refunds
  - `refund_amount_available` integer — Amount in pence. Total amount still available before issuing the refund

## Response `200`

successful operation

- Refund
  - `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.

## Other responses

- `202` — ACCEPTED
- `401` — Credentials are required to access this resource
- `404` — Not found
- `412` — Refund amount available mismatch
- `429` — Too many requests
- `500` — Downstream system error

## Changes

- **2019-10-08** `6d52e43c48aa` — 5 breaking, 2 info
  - removed the request body
  - removed the media type `application/json` for the response with the status `200`
  - removed the media type `application/json` for the response with the status `404`
  - removed the media type `application/json` for the response with the status `429`
  - …3 more
- **2019-10-06** `884c555517bc` — 1 breaking, 6 info
  - added required request body
  - the endpoint scheme security `BearerAuth` was added to the API
  - the endpoint scheme security `Authorization` was removed from the API
  - added the media type `application/json` for the response with the status `200`
  - …3 more
- **2019-08-01** `67d0d7421447` — 2 info
  - api tag `Refunding card payments` added
  - api tag `Refunding payments` removed
- **2019-08-01** `6e01c8022b87` — 2 info
  - api tag `Refunding payments` added
  - api tag `Refunds` removed
- **2019-07-31** `f8066d82895d` — 1 info
  - api operation id `submitRefund` removed and replaced with `Submit a refund for a payment`

[Full history](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/changes/v1/payments/:paymentId/refunds/post.md)

---

[API](https://skmtc.dev/alphagov/apis/gov-uk-pay-api.md) · [All operations](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/llms.txt) · [OpenAPI document](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/revisions/262275a01170?raw)
