Sign in

v39

latestOpenAPI 3.0.1raw.githubusercontent.com2025-10-031646108.8 KB
Refunding card payments

Get information about a payment’s refunds

You can use this endpoint to get a list of refunds for a payment.

get/v1/payments/{paymentId}/refunds

Path parameters

paymentIdstring required

The unique payment_id of the payment you want a list of refunds for.

Response

OK - your request was successful.

payment_idstring

The unique ID GOV.UK Pay associated with this payment when you created it.

Example response

{
  "_embedded": {
    "refunds": [
      {
        "_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"
      }
    ]
  },
  "_links": {
    "payment": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  },
  "payment_id": "hu20sqlact5260q2nanm0q8u93"
}