Shift4 Payments API — Payouts

naftiko: 1.0.0-alpha2
info:
  label: Shift4 Payments API — Payouts
  description: 'Shift4 Payments API — Payouts. 2 operations. Lead operation: List Payouts. Self-contained Naftiko capability
    covering one Shift4 Payments business surface.'
  tags:
  - Shift4 Payments
  - Payouts
  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-payouts
    baseUri: https://api.shift4.com
    description: Shift4 Payments API — Payouts business capability. Self-contained, no shared references.
    resources:
    - name: payouts
      path: /payouts
      operations:
      - name: listpayouts
        method: GET
        description: List Payouts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payouts-payoutId
      path: /payouts/{payoutId}
      operations:
      - name: getpayout
        method: GET
        description: Retrieve a Payout
        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-payouts-rest
    port: 8080
    description: REST adapter for Shift4 Payments API — Payouts. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/payouts
      name: payouts
      description: REST surface for payouts.
      operations:
      - method: GET
        name: listpayouts
        description: List Payouts
        call: shift4-payouts.listpayouts
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payouts/{payoutid}
      name: payouts-payoutid
      description: REST surface for payouts-payoutId.
      operations:
      - method: GET
        name: getpayout
        description: Retrieve a Payout
        call: shift4-payouts.getpayout
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shift4-payouts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shift4 Payments API — Payouts. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-payouts
      description: List Payouts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-payouts.listpayouts
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-payout
      description: Retrieve a Payout
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-payouts.getpayout
      outputParameters:
      - type: object
        mapping: $.