GOV.UK Pay · Schema

ErrorResponse

An error response

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhooks

Properties

Name Type Description
code string A GOV.UK Pay API error code. You can [find out more about this code in our documentation](https://docs.payments.service.gov.uk/api_reference/#gov-uk-pay-api-error-codes).
description string Additional details about the error
View JSON Schema on GitHub

JSON Schema

ErrorResponse.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/ErrorResponse.json",
  "title": "ErrorResponse",
  "type": "object",
  "description": "An error response",
  "properties": {
    "code": {
      "type": "string",
      "description": "A GOV.UK Pay API error code. You can [find out more about this code in our documentation](https://docs.payments.service.gov.uk/api_reference/#gov-uk-pay-api-error-codes).",
      "example": "P0900"
    },
    "description": {
      "type": "string",
      "description": "Additional details about the error",
      "example": "Too many requests"
    }
  }
}