Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account Transfers API

9 actions 9 updates phrasing extends openapi/stripe-transfers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Stripe's API. It is a proposal applied on top of the contract, not a document Stripe publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/v1/transfers'].get
$.paths['/v1/transfers'].post
$.paths['/v1/transfers/{id}/reversals'].get
$.paths['/v1/transfers/{id}/reversals'].post
$.paths['/v1/transfers/{transfer}'].get
$.paths['/v1/transfers/{transfer}'].post
$.paths['/v1/transfers/{transfer}/reversals/{id}'].get
$.paths['/v1/transfers/{transfer}/reversals/{id}'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Accounts Account Transfers API
  version: 1.0.0
extends: openapi/stripe-transfers-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: 8
- target: $.paths['/v1/transfers'].get
  update:
    x-apievangelist-phrasing:
      intent: List transfers to connected accounts
      effect: read
      questions:
      - How do I see the money I've sent to connected accounts?
      - Can I list only the transfers that went to one connected account?
      - How do I find all transfers that belong to one order's transfer group?
      instructions:
      - text: List my recent transfers.
      - text: List transfers sent to connected account {destination}.
        slots:
          destination: query.destination
      - text: Show transfers in transfer group {transfer_group}.
        slots:
          transfer_group: query.transfer_group
      - text: List up to {limit} transfers created {created}.
        slots:
          limit: query.limit
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Send funds to a connected account
      effect: write
      questions:
      - How do I pay out part of a sale to a seller's connected account?
      - What happens if my balance can't cover a transfer?
      - Can I transfer funds from a charge before they reach my available balance?
      instructions:
      - text: Transfer {amount} {currency} to connected account {destination}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          destination: requestBody.destination
      - text: Send {amount} {currency} to account {destination} funded by charge {source_transaction}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          destination: requestBody.destination
          source_transaction: requestBody.source_transaction
      - text: Transfer {amount} {currency} to {destination} as part of group {transfer_group}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          destination: requestBody.destination
          transfer_group: requestBody.transfer_group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transfers/{id}/reversals'].get
  update:
    x-apievangelist-phrasing:
      intent: List reversals of a transfer
      effect: read
      questions:
      - How do I see every reversal made against a transfer?
      - Can I page past the ten most recent reversals on a transfer?
      instructions:
      - text: List reversals on transfer {id}.
        slots:
          id: path.id
      - text: Show up to {limit} reversals for transfer {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transfers/{id}/reversals'].post
  update:
    x-apievangelist-phrasing:
      intent: Reverse a transfer to a connected account
      effect: destructive
      questions:
      - How do I pull money back from a connected account after a transfer?
      - Can I reverse only part of a transfer, more than once?
      - Is the application fee refunded when I reverse a transfer?
      instructions:
      - text: Reverse transfer {id} in full.
        slots:
          id: path.id
      - text: Reverse {amount} of transfer {id}.
        slots:
          amount: requestBody.amount
          id: path.id
      - text: 'Reverse transfer {id} and refund the application fee too: {refund_application_fee}.'
        slots:
          id: path.id
          refund_application_fee: requestBody.refund_application_fee
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transfers/{transfer}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transfer
      effect: read
      questions:
      - How do I look up the details of one transfer?
      - Has a particular transfer been reversed?
      instructions:
      - text: Show transfer {transfer}.
        slots:
          transfer: path.transfer
      - text: Get the amount and destination of transfer {transfer}.
        slots:
          transfer: path.transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transfers/{transfer}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a transfer's description or metadata
      effect: write
      questions:
      - How do I add my own notes or metadata to an existing transfer?
      - Can I change the amount of a transfer after it's sent?
      instructions:
      - text: Set the description of transfer {transfer} to {description}.
        slots:
          transfer: path.transfer
          description: requestBody.description
      - text: Add metadata {metadata} to transfer {transfer}.
        slots:
          metadata: requestBody.metadata
          transfer: path.transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transfers/{transfer}/reversals/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one reversal of a transfer
      effect: read
      questions:
      - How do I look up a specific reversal on a transfer?
      - How much was pulled back in a given transfer reversal?
      instructions:
      - text: Show reversal {id} on transfer {transfer}.
        slots:
          id: path.id
          transfer: path.transfer
      - text: Get the details of transfer reversal {id} for transfer {transfer}.
        slots:
          id: path.id
          transfer: path.transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transfers/{transfer}/reversals/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a transfer reversal's metadata
      effect: write
      questions:
      - How do I annotate a transfer reversal with metadata?
      - What fields can I edit on a transfer reversal?
      instructions:
      - text: Add metadata {metadata} to reversal {id} on transfer {transfer}.
        slots:
          metadata: requestBody.metadata
          id: path.id
          transfer: path.transfer
      - text: Update reversal {id} of transfer {transfer}.
        slots:
          id: path.id
          transfer: path.transfer
      method: generated
      generated: '2026-09-26'