GOV.UK Pay · Schema

DisputeDetailForSearch

Contains disputes matching your search criteria.

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhook

Properties

Name Type Description
_links object
amount integer The disputed amount in pence.
created_date string The date and time the user's bank told GOV.UK Pay about this dispute.
dispute_id string The unique ID GOV.UK Pay automatically associated with this dispute when the paying user disputed the payment.
evidence_due_date string The deadline for submitting your supporting evidence. This value uses Coordinated Universal Time (UTC) and ISO 8601 format
fee integer The payment service provider’s dispute fee, in pence.
net_amount integer The amount, in pence, your payment service provider will take for a lost dispute. 'net_amount' is deducted from your payout after you lose the dispute. For example, a 'net_amount' of '-1500' means you
payment_id string The unique ID GOV.UK Pay automatically associated with this payment when you created it.
reason string The reason the paying user gave for disputing this payment. Possible values are: 'credit_not_processed', 'duplicate', 'fraudulent', 'general', 'product_not_received', 'product_unacceptable', 'unrecogn
settlement_summary object
status string The current status of the dispute. Possible values are: 'needs_response', 'won', 'lost', 'under_review'
View JSON Schema on GitHub

JSON Schema

DisputeDetailForSearch.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/DisputeDetailForSearch.json",
  "title": "DisputeDetailForSearch",
  "type": "object",
  "description": "Contains disputes matching your search criteria.",
  "properties": {
    "_links": {
      "$ref": "#/components/schemas/DisputeLinksForSearch"
    },
    "amount": {
      "type": "integer",
      "format": "int64",
      "description": "The disputed amount in pence.",
      "example": 1200,
      "readOnly": true
    },
    "created_date": {
      "type": "string",
      "description": "The date and time the user's bank told GOV.UK Pay about this dispute.",
      "example": "2022-07-28T16:43:00.000Z",
      "readOnly": true
    },
    "dispute_id": {
      "type": "string",
      "description": "The unique ID GOV.UK Pay automatically associated with this dispute when the paying user disputed the payment.",
      "example": "hu20sqlact5260q2nanm0q8u93",
      "readOnly": true
    },
    "evidence_due_date": {
      "type": "string",
      "description": "The deadline for submitting your supporting evidence. This value uses Coordinated Universal Time (UTC) and ISO 8601 format",
      "example": "2022-07-28T16:43:00.000Z",
      "readOnly": true
    },
    "fee": {
      "type": "integer",
      "format": "int64",
      "description": "The payment service provider\u2019s dispute fee, in pence.",
      "example": 1200,
      "readOnly": true
    },
    "net_amount": {
      "type": "integer",
      "format": "int64",
      "description": "The amount, in pence, your payment service provider will take for a lost dispute. 'net_amount' is deducted from your payout after you lose the dispute. For example, a 'net_amount' of '-1500' means your PSP will take \u00a315.00 from your next payout into your bank account. 'net_amount' is always a negative value. 'net_amount' only appears if you lose the dispute.",
      "example": -2400,
      "readOnly": true
    },
    "payment_id": {
      "type": "string",
      "description": "The unique ID GOV.UK Pay automatically associated with this payment when you created it.",
      "example": "hu20sqlact5260q2nanm0q8u93",
      "readOnly": true
    },
    "reason": {
      "type": "string",
      "description": "The reason the paying user gave for disputing this payment. Possible values are: 'credit_not_processed', 'duplicate', 'fraudulent', 'general', 'product_not_received', 'product_unacceptable', 'unrecognised', 'subscription_cancelled', >'other'",
      "example": "fraudulent",
      "readOnly": true
    },
    "settlement_summary": {
      "$ref": "#/components/schemas/SettlementSummary"
    },
    "status": {
      "type": "string",
      "description": "The current status of the dispute. Possible values are: 'needs_response', 'won', 'lost', 'under_review'",
      "example": "under_review",
      "readOnly": true
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/DisputeDetailForSearch"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.