Shift4 Payments API — Plans

naftiko: 1.0.0-alpha2
info:
  label: Shift4 Payments API — Plans
  description: 'Shift4 Payments API — Plans. 4 operations. Lead operation: Create a Plan. Self-contained Naftiko capability
    covering one Shift4 Payments business surface.'
  tags:
  - Shift4 Payments
  - Plans
  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-plans
    baseUri: https://api.shift4.com
    description: Shift4 Payments API — Plans business capability. Self-contained, no shared references.
    resources:
    - name: plans
      path: /plans
      operations:
      - name: createplan
        method: POST
        description: Create a Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listplans
        method: GET
        description: List Plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: plans-planId
      path: /plans/{planId}
      operations:
      - name: getplan
        method: GET
        description: Retrieve a Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateplan
        method: POST
        description: Update a Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.SHIFT4_PAYMENTS_USER}}'
      password: '{{env.SHIFT4_PAYMENTS_PASS}}'
  exposes:
  - type: rest
    namespace: shift4-plans-rest
    port: 8080
    description: REST adapter for Shift4 Payments API — Plans. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/plans
      name: plans
      description: REST surface for plans.
      operations:
      - method: POST
        name: createplan
        description: Create a Plan
        call: shift4-plans.createplan
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listplans
        description: List Plans
        call: shift4-plans.listplans
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plans/{planid}
      name: plans-planid
      description: REST surface for plans-planId.
      operations:
      - method: GET
        name: getplan
        description: Retrieve a Plan
        call: shift4-plans.getplan
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updateplan
        description: Update a Plan
        call: shift4-plans.updateplan
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shift4-plans-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shift4 Payments API — Plans. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-plan
      description: Create a Plan
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shift4-plans.createplan
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-plans
      description: List Plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-plans.listplans
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-plan
      description: Retrieve a Plan
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-plans.getplan
      outputParameters:
      - type: object
        mapping: $.
    - name: update-plan
      description: Update a Plan
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shift4-plans.updateplan
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.