HMRC VAT (Making Tax Digital) API — Payments

naftiko: 1.0.0-alpha2
info:
  label: HMRC VAT (Making Tax Digital) API — Payments
  description: 'HMRC VAT (Making Tax Digital) API — Payments. 1 operations. Lead operation: Retrieve VAT payments. Self-contained
    Naftiko capability covering one Hmrc business surface.'
  tags:
  - Hmrc
  - Payments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HMRC_API_KEY: HMRC_API_KEY
capability:
  consumes:
  - type: http
    namespace: vat-mtd-payments
    baseUri: https://api.service.hmrc.gov.uk
    description: HMRC VAT (Making Tax Digital) API — Payments business capability. Self-contained, no shared references.
    resources:
    - name: organisations-vat-vrn-payments
      path: /organisations/vat/{vrn}/payments
      operations:
      - name: getvatpayments
        method: GET
        description: Retrieve VAT payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vrn
          in: path
          type: string
          required: true
        - name: from
          in: query
          type: string
          required: true
        - name: to
          in: query
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.HMRC_API_KEY}}'
  exposes:
  - type: rest
    namespace: vat-mtd-payments-rest
    port: 8080
    description: REST adapter for HMRC VAT (Making Tax Digital) API — Payments. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organisations/vat/{vrn}/payments
      name: organisations-vat-vrn-payments
      description: REST surface for organisations-vat-vrn-payments.
      operations:
      - method: GET
        name: getvatpayments
        description: Retrieve VAT payments
        call: vat-mtd-payments.getvatpayments
        with:
          vrn: rest.vrn
          from: rest.from
          to: rest.to
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vat-mtd-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for HMRC VAT (Making Tax Digital) API — Payments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieve-vat-payments
      description: Retrieve VAT payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vat-mtd-payments.getvatpayments
      with:
        vrn: tools.vrn
        from: tools.from
        to: tools.to
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.