GOV.UK Pay · Schema

RefundForSearchResult

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhooks

Properties

Name	Type	Description
_embedded	object
_links	object
payment_id	string	The unique ID GOV.UK Pay associated with this payment when you created it.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/RefundForSearchResult.json",
  "title": "RefundForSearchResult",
  "type": "object",
  "properties": {
    "_embedded": {
      "$ref": "#/components/schemas/EmbeddedRefunds"
    },
    "_links": {
      "$ref": "#/components/schemas/RefundLinksForSearch"
    },
    "payment_id": {
      "type": "string",
      "description": "The unique ID GOV.UK Pay associated with this payment when you created it.",
      "example": "hu20sqlact5260q2nanm0q8u93"
    }
  }
}