Shift4 Payments API — Checkout Sessions

naftiko: 1.0.0-alpha2
info:
  label: Shift4 Payments API — Checkout Sessions
  description: 'Shift4 Payments API — Checkout Sessions. 2 operations. Lead operation: Create a Checkout Session. Self-contained
    Naftiko capability covering one Shift4 Payments business surface.'
  tags:
  - Shift4 Payments
  - Checkout Sessions
  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-checkout-sessions
    baseUri: https://api.shift4.com
    description: Shift4 Payments API — Checkout Sessions business capability. Self-contained, no shared references.
    resources:
    - name: checkout-sessions
      path: /checkout/sessions
      operations:
      - name: createcheckoutsession
        method: POST
        description: Create a Checkout Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: checkout-sessions-sessionId
      path: /checkout/sessions/{sessionId}
      operations:
      - name: getcheckoutsession
        method: GET
        description: Retrieve a Checkout Session
        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-checkout-sessions-rest
    port: 8080
    description: REST adapter for Shift4 Payments API — Checkout Sessions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/checkout/sessions
      name: checkout-sessions
      description: REST surface for checkout-sessions.
      operations:
      - method: POST
        name: createcheckoutsession
        description: Create a Checkout Session
        call: shift4-checkout-sessions.createcheckoutsession
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/checkout/sessions/{sessionid}
      name: checkout-sessions-sessionid
      description: REST surface for checkout-sessions-sessionId.
      operations:
      - method: GET
        name: getcheckoutsession
        description: Retrieve a Checkout Session
        call: shift4-checkout-sessions.getcheckoutsession
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shift4-checkout-sessions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shift4 Payments API — Checkout Sessions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-checkout-session
      description: Create a Checkout Session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shift4-checkout-sessions.createcheckoutsession
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-checkout-session
      description: Retrieve a Checkout Session
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-checkout-sessions.getcheckoutsession
      outputParameters:
      - type: object
        mapping: $.