Shift4 Payments API — Blacklist

naftiko: 1.0.0-alpha2
info:
  label: Shift4 Payments API — Blacklist
  description: 'Shift4 Payments API — Blacklist. 5 operations. Lead operation: Create a Blacklist Rule. Self-contained Naftiko
    capability covering one Shift4 Payments business surface.'
  tags:
  - Shift4 Payments
  - Blacklist
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIFT4_PAYMENTS_API_KEY: SHIFT4_PAYMENTS_API_KEY
capability:
  consumes:
  - type: http
    namespace: shift4-blacklist
    baseUri: https://api.shift4.com
    description: Shift4 Payments API — Blacklist business capability. Self-contained, no shared references.
    resources:
    - name: blacklist
      path: /blacklist
      operations:
      - name: createblacklistrule
        method: POST
        description: Create a Blacklist Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listblacklistrules
        method: GET
        description: List Blacklist Rules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: blacklist-ruleId
      path: /blacklist/{ruleId}
      operations:
      - name: getblacklistrule
        method: GET
        description: Retrieve a Blacklist Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateblacklistrule
        method: POST
        description: Update a Blacklist Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteblacklistrule
        method: DELETE
        description: Delete a Blacklist Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.SHIFT4_PAYMENTS_USER}}'
      password: '{{env.SHIFT4_PAYMENTS_PASS}}'
  exposes:
  - type: rest
    namespace: shift4-blacklist-rest
    port: 8080
    description: REST adapter for Shift4 Payments API — Blacklist. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/blacklist
      name: blacklist
      description: REST surface for blacklist.
      operations:
      - method: POST
        name: createblacklistrule
        description: Create a Blacklist Rule
        call: shift4-blacklist.createblacklistrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listblacklistrules
        description: List Blacklist Rules
        call: shift4-blacklist.listblacklistrules
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/blacklist/{ruleid}
      name: blacklist-ruleid
      description: REST surface for blacklist-ruleId.
      operations:
      - method: GET
        name: getblacklistrule
        description: Retrieve a Blacklist Rule
        call: shift4-blacklist.getblacklistrule
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updateblacklistrule
        description: Update a Blacklist Rule
        call: shift4-blacklist.updateblacklistrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteblacklistrule
        description: Delete a Blacklist Rule
        call: shift4-blacklist.deleteblacklistrule
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shift4-blacklist-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shift4 Payments API — Blacklist. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-blacklist-rule
      description: Create a Blacklist Rule
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: shift4-blacklist.createblacklistrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-blacklist-rules
      description: List Blacklist Rules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-blacklist.listblacklistrules
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-blacklist-rule
      description: Retrieve a Blacklist Rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-blacklist.getblacklistrule
      outputParameters:
      - type: object
        mapping: $.
    - name: update-blacklist-rule
      description: Update a Blacklist Rule
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: shift4-blacklist.updateblacklistrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-blacklist-rule
      description: Delete a Blacklist Rule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: shift4-blacklist.deleteblacklistrule
      outputParameters:
      - type: object
        mapping: $.