ALalphagov
Refunding card payments

Find payment refund by ID

Changed on

Return payment refund information by Refund ID The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

get/v1/payments/{paymentId}/refunds/{refundId}

Request

  • Base URL
    https://publicapi.payments.service.gov.uk
  • URL
    https://publicapi.payments.service.gov.uk/v1/payments/{paymentId}/refunds/{refundId}
  • Auth
    API key in header Authorization

Path parameters

paymentIdstring required
refundIdstring required

Response

OK

refund_idstring
created_datestring
amountinteger
status'submitted' | 'success' | 'error'

Example response

{
  "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