# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Payouts API
  version: 1.0.0
extends: openapi/stripe-payouts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/payouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List payouts
      effect: read
      questions:
      - How do I see all the payouts sent to my bank account?
      - Can I find payouts that failed or are still pending?
      - Can I filter payouts by the date they arrive?
      instructions:
      - text: List my recent payouts.
      - text: List payouts with status {status}.
        slots:
          status: query.status
      - text: Show payouts sent to destination {destination}.
        slots:
          destination: query.destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payouts'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay out funds to a bank account
      effect: write
      questions:
      - How do I send money from my balance to my bank account?
      - Can I request an instant payout instead of a standard one?
      - What happens if my balance doesn't cover the payout?
      instructions:
      - text: Pay out {amount} {currency} to my bank account.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
      - text: Send a payout of {amount} {currency} using the {method} method.
        slots:
          method: requestBody.method
          amount: requestBody.amount
          currency: requestBody.currency
      - text: Pay out {amount} {currency} to destination {destination}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          destination: requestBody.destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payouts/{payout}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a payout
      effect: read
      questions:
      - How do I check the status of a specific payout?
      - When will a particular payout arrive in my bank?
      instructions:
      - text: Get payout {payout}.
        slots:
          payout: path.payout
      - text: Show the status and arrival date of payout {payout}.
        slots:
          payout: path.payout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payouts/{payout}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a payout's metadata
      effect: write
      questions:
      - Can I add my own reference data to a payout that already exists?
      - What can I change on a payout after it's created?
      instructions:
      - text: Update the metadata on payout {payout} to {metadata}.
        slots:
          payout: path.payout
          metadata: requestBody.metadata
      - text: Tag payout {payout} with metadata {metadata}.
        slots:
          payout: path.payout
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payouts/{payout}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending payout
      effect: destructive
      questions:
      - How do I stop a payout that hasn't been paid out yet?
      - Can I cancel an automatic payout?
      instructions:
      - text: Cancel payout {payout}.
        slots:
          payout: path.payout
      - text: Stop pending payout {payout} and return the funds to my balance.
        slots:
          payout: path.payout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payouts/{payout}/reverse'].post
  update:
    x-apievangelist-phrasing:
      intent: Reverse a completed payout
      effect: destructive
      questions:
      - How do I pull back a payout that already reached a bank account?
      - Which payouts can be reversed?
      instructions:
      - text: Reverse payout {payout}.
        slots:
          payout: path.payout
      - text: Reverse payout {payout} to pull the funds back, noting it with {metadata}.
        slots:
          payout: path.payout
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'