ALalphagov
Refunding card payments

Get all refunds for a payment

Changed on

Return refunds for a payment. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

get/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
    API key in header Authorization

Path parameters

paymentIdstring required

Response

OK

payment_idstring

Example response

{
  "payment_id": "hu20sqlact5260q2nanm0q8u93",
  "_links": {
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "payment": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  },
  "_embedded": {
    "refunds": [
      {
        "refund_id": "act4c33g40j3edfmi8jknab84x",
        "created_date": "2017-01-10T16:52:07.855Z",
        "amount": 120,
        "_links": {
          "self": {
            "href": "https://an.example.link/from/payment/platform",
            "method": "GET"
          },
          "payment": {
            "href": "https://an.example.link/from/payment/platform",
            "method": "GET"
          }
        },
        "status": "success",
        "settlement_summary": {
          "settled_date": "2016-01-21"
        }
      }
    ]
  }
}

Changes

  • 6d52e43c48aaRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • info

      the endpoint scheme security Authorization was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

  • 884c555517bcRevision changes
    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security Authorization was removed from the API

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status