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

# Refund a payment

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

## Request

- Base URL: `https://publicapi.payments.service.gov.uk`
- URL: `https://publicapi.payments.service.gov.uk/v1/payments/{paymentId}/refunds`
- Auth: HTTP bearer

You can use this endpoint to [fully or partially refund a payment](https://docs.payments.service.gov.uk/refunding_payments).

## Path parameters

- `paymentId` string, required

## Request body

- PaymentRefundRequest: The Payment Refund Request Payload
  - `amount` integer, required: The amount you want to [refund to your user](https://docs.payments.service.gov.uk/refunding_payments/) in pence.
  - `refund_amount_available` integer: Amount in pence. Total amount still available before issuing the refund

## Response `200`

successful operation

- Refund
  - `_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`.
  - `fee` integer: The fee, in pence, charged for processing the refund.
  - `net_amount` integer: The net amount, in pence, associated with the refund, including any fee applicable.
  - `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).

## Other responses

- `202`: ACCEPTED
- `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)
- `404`: Not found
- `412`: Refund amount available mismatch
- `429`: Too many requests
- `500`: Downstream system error

## Changes

- **2026-10-13** `6dc4b2c91eb8`: 2 info
  - added the optional property `fee` to the response with the `200` status
  - added the optional property `net_amount` to the response with the `200` status
- **2024-02-22** `eafdca6d5023`: 1 info
  - added the optional property `payment_id` to the response with the `200` status
- **2023-04-18** `c8f226fc66d4`: 2 info
  - added the optional property `header` to the response with the `404` status
  - added the optional property `header` to the response with the `500` status
- **2022-08-30** `edf9de8bb929`: 1 info
  - the request optional property `refund_amount_available` became not read-only

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

---

[API](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api.md) - [All operations](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api/revisions/6dc4b2c91eb8?raw)