GOV.UK Pay · Schema

PaymentRefundRequest

The Payment Refund Request Payload

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhooks

Properties

Name	Type	Description
amount	integer	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

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/PaymentRefundRequest.json",
  "title": "PaymentRefundRequest",
  "type": "object",
  "description": "The Payment Refund Request Payload",
  "properties": {
    "amount": {
      "type": "integer",
      "format": "int32",
      "description": "The amount you want to [refund to your user](https://docs.payments.service.gov.uk/refunding_payments/) in pence.",
      "example": 150000,
      "maximum": 10000000,
      "minimum": 1
    },
    "refund_amount_available": {
      "type": "integer",
      "format": "int32",
      "description": "Amount in pence. Total amount still available before issuing the refund",
      "example": 200000,
      "maximum": 10000000,
      "minimum": 1
    }
  },
  "required": [
    "amount"
  ]
}