API Evangelist conversational phrasing for Stripe Test Helpers API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Test Helpers API
  version: 1.0.0
extends: openapi/stripe-test-helpers-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: 31
- target: $.paths['/v1/test_helpers/customers/{customer}/fund_cash_balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Simulate a bank transfer into a customer's cash balance
      effect: write
      questions:
      - How do I fund a customer's cash balance in test mode without a real bank transfer?
      - Can I simulate an incoming bank transfer with my own reference string?
      instructions:
      - text: Fund test customer {customer} with a simulated bank transfer of {amount} {currency}.
        slots:
          customer: path.customer
          amount: requestBody.amount
          currency: requestBody.currency
      - text: Simulate an incoming bank transfer of {amount} {currency} to customer {customer} with reference {reference}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          customer: path.customer
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/authorizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test card authorization
      effect: write
      questions:
      - How do I simulate a card authorization on an issued card in test mode?
      - Can a test authorization come from a digital wallet instead of a physical card swipe?
      instructions:
      - text: Create a test authorization of {amount} {currency} on issued card {card}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          card: requestBody.card
      - text: Simulate a {authorization_method} authorization for {amount} on test card {card}.
        slots:
          authorization_method: requestBody.authorization_method
          amount: requestBody.amount
          card: requestBody.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/authorizations/{authorization}/capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a test card authorization
      effect: write
      questions:
      - How do I capture a test-mode issuing authorization to turn it into a transaction?
      - Can I capture less than the authorized amount and close the authorization in test mode?
      instructions:
      - text: Capture test authorization {authorization}.
        slots:
          authorization: path.authorization
      - text: Capture {capture_amount} on test authorization {authorization} and close it afterwards.
        slots:
          capture_amount: requestBody.capture_amount
          authorization: path.authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/authorizations/{authorization}/expire'].post
  update:
    x-apievangelist-phrasing:
      intent: Expire a test card authorization
      effect: destructive
      questions:
      - How do I make a test issuing authorization expire so I can test that outcome?
      - What happens to a test authorization that is never captured?
      instructions:
      - text: Expire test authorization {authorization}.
        slots:
          authorization: path.authorization
      - text: Force issuing authorization {authorization} to expire in test mode.
        slots:
          authorization: path.authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/authorizations/{authorization}/increment'].post
  update:
    x-apievangelist-phrasing:
      intent: Increase a test card authorization amount
      effect: write
      questions:
      - How do I simulate a merchant raising the amount on a test card authorization?
      - Can I test an incremental authorization on an issued card, like a hotel adding charges?
      instructions:
      - text: Increase test authorization {authorization} by {increment_amount}.
        slots:
          authorization: path.authorization
          increment_amount: requestBody.increment_amount
      - text: Add {increment_amount} to the held amount on issuing authorization {authorization}.
        slots:
          increment_amount: requestBody.increment_amount
          authorization: path.authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/authorizations/{authorization}/reverse'].post
  update:
    x-apievangelist-phrasing:
      intent: Reverse a test card authorization
      effect: destructive
      questions:
      - How do I simulate a merchant reversing a test card authorization?
      - Can I reverse only part of a test authorization?
      instructions:
      - text: Reverse test authorization {authorization} in full.
        slots:
          authorization: path.authorization
      - text: Reverse {reverse_amount} of issuing authorization {authorization}.
        slots:
          reverse_amount: requestBody.reverse_amount
          authorization: path.authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/cards/{card}/shipping/deliver'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a test physical card as delivered
      effect: write
      questions:
      - How do I simulate a physical issued card arriving at the cardholder in test mode?
      - Can I move a test card's shipping status to delivered?
      instructions:
      - text: Mark test card {card} as delivered.
        slots:
          card: path.card
      - text: Simulate delivery of the physical card {card}.
        slots:
          card: path.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/cards/{card}/shipping/fail'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a test card shipment as failed
      effect: write
      questions:
      - How do I test what happens when a physical card shipment fails?
      - Can I set a test card's shipping status to failure?
      instructions:
      - text: Mark the shipment of test card {card} as failed.
        slots:
          card: path.card
      - text: Simulate a failed shipment for physical card {card}.
        slots:
          card: path.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/cards/{card}/shipping/return'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a test card shipment as returned
      effect: write
      questions:
      - How do I simulate a physical card being returned to sender in test mode?
      - Can I test the returned shipping status on an issued card?
      instructions:
      - text: Mark test card {card} as returned to sender.
        slots:
          card: path.card
      - text: Simulate the return of the physical card {card} in shipping.
        slots:
          card: path.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/cards/{card}/shipping/ship'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a test physical card as shipped
      effect: write
      questions:
      - How do I simulate a physical issued card being shipped in test mode?
      - Can I move a test card's shipping status to shipped before it is delivered?
      instructions:
      - text: Mark test card {card} as shipped.
        slots:
          card: path.card
      - text: Simulate the physical card {card} leaving for the cardholder.
        slots:
          card: path.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/transactions/create_force_capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Simulate a forced capture on an issued card
      effect: write
      questions:
      - How do I test a forced capture where a merchant charges a card without an authorization?
      - Can I simulate a force capture of an arbitrary amount on a test issued card?
      instructions:
      - text: Create a forced capture of {amount} {currency} on test card {card}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          card: requestBody.card
      - text: Simulate a merchant capturing {amount} on card {card} with no prior authorization.
        slots:
          amount: requestBody.amount
          card: requestBody.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/transactions/create_unlinked_refund'].post
  update:
    x-apievangelist-phrasing:
      intent: Simulate an unlinked refund on an issued card
      effect: write
      questions:
      - How do I test a refund to an issued card that isn't tied to an earlier transaction?
      - Can I simulate an unlinked refund of any amount in test mode?
      instructions:
      - text: Create an unlinked refund of {amount} {currency} to test card {card}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          card: requestBody.card
      - text: Simulate a merchant refunding {amount} to card {card} without an original transaction.
        slots:
          amount: requestBody.amount
          card: requestBody.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/issuing/transactions/{transaction}/refund'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a test issuing transaction
      effect: write
      questions:
      - How do I simulate a merchant refunding an existing test issuing transaction?
      - Can I refund only part of a test card transaction?
      instructions:
      - text: Refund test issuing transaction {transaction}.
        slots:
          transaction: path.transaction
      - text: Refund {refund_amount} of card transaction {transaction} in test mode.
        slots:
          refund_amount: requestBody.refund_amount
          transaction: path.transaction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/refunds/{refund}/expire'].post
  update:
    x-apievangelist-phrasing:
      intent: Expire a test refund awaiting action
      effect: destructive
      questions:
      - How do I test what happens when a refund that needs customer action expires?
      - Can I expire a refund that isn't in the requires_action status?
      instructions:
      - text: Expire test refund {refund}.
        slots:
          refund: path.refund
      - text: Force refund {refund}, which is waiting on action, to expire.
        slots:
          refund: path.refund
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/terminal/readers/{reader}/present_payment_method'].post
  update:
    x-apievangelist-phrasing:
      intent: Present a payment method on a simulated reader
      effect: write
      questions:
      - How do I simulate a customer tapping a card on a test Terminal reader?
      - Can I add a tip when presenting a payment method on a simulated reader?
      - Which payment method types can I present on a simulated in-person reader?
      instructions:
      - text: Present a test card on simulated reader {reader}.
        slots:
          reader: path.reader
      - text: Present a {type} payment method on reader {reader} with a tip of {amount_tip}.
        slots:
          type: requestBody.type
          reader: path.reader
          amount_tip: requestBody.amount_tip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/test_clocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List test clocks
      effect: read
      questions:
      - Which test clocks have I set up for simulating billing over time?
      - How do I see all my test clocks?
      instructions:
      - text: List my test clocks.
      - text: Show the first {limit} test clocks.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/test_clocks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test clock
      effect: write
      questions:
      - How do I simulate time passing for subscriptions without waiting weeks?
      - Can I start a test clock frozen at a specific date?
      instructions:
      - text: Create a test clock frozen at {frozen_time}.
        slots:
          frozen_time: requestBody.frozen_time
      - text: Create a test clock named {name} starting at {frozen_time}.
        slots:
          name: requestBody.name
          frozen_time: requestBody.frozen_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/test_clocks/{test_clock}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test clock
      effect: read
      questions:
      - How do I check what time a test clock is frozen at?
      - Is my test clock still advancing or is it ready?
      instructions:
      - text: Show test clock {test_clock}.
        slots:
          test_clock: path.test_clock
      - text: Check the status and current time of test clock {test_clock}.
        slots:
          test_clock: path.test_clock
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/test_clocks/{test_clock}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test clock
      effect: destructive
      questions:
      - How do I delete a test clock I no longer need?
      - Can I clean up an old billing simulation clock?
      instructions:
      - text: Delete test clock {test_clock}.
        slots:
          test_clock: path.test_clock
      - text: Remove the test clock {test_clock} and end that simulation.
        slots:
          test_clock: path.test_clock
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/test_clocks/{test_clock}/advance'].post
  update:
    x-apievangelist-phrasing:
      intent: Advance a test clock to a future time
      effect: write
      questions:
      - How do I fast-forward a test clock to trigger renewals and invoices?
      - How do I know when a test clock has finished advancing?
      instructions:
      - text: Advance test clock {test_clock} to {frozen_time}.
        slots:
          test_clock: path.test_clock
          frozen_time: requestBody.frozen_time
      - text: Move the simulation on clock {test_clock} forward to {frozen_time} so billing runs.
        slots:
          test_clock: path.test_clock
          frozen_time: requestBody.frozen_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/inbound_transfers/{id}/fail'].post
  update:
    x-apievangelist-phrasing:
      intent: Fail a test inbound transfer
      effect: write
      questions:
      - How do I test a failed inbound transfer into a financial account?
      - Can I fail an inbound transfer that has already succeeded?
      instructions:
      - text: Fail test inbound transfer {id}.
        slots:
          id: path.id
      - text: Move processing inbound transfer {id} to failed with details {failure_details}.
        slots:
          id: path.id
          failure_details: requestBody.failure_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/inbound_transfers/{id}/return'].post
  update:
    x-apievangelist-phrasing:
      intent: Return a test inbound transfer
      effect: write
      questions:
      - How do I simulate an inbound transfer being returned after it succeeded?
      - What status must an inbound transfer be in before I can mark it returned?
      instructions:
      - text: Mark test inbound transfer {id} as returned.
        slots:
          id: path.id
      - text: Simulate a return on succeeded inbound transfer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/inbound_transfers/{id}/succeed'].post
  update:
    x-apievangelist-phrasing:
      intent: Succeed a test inbound transfer
      effect: write
      questions:
      - How do I make a test inbound transfer succeed right away?
      - Can I complete an inbound transfer that is still processing in test mode?
      instructions:
      - text: Mark test inbound transfer {id} as succeeded.
        slots:
          id: path.id
      - text: Complete processing inbound transfer {id} successfully.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/outbound_payments/{id}/fail'].post
  update:
    x-apievangelist-phrasing:
      intent: Fail a test outbound payment
      effect: write
      questions:
      - How do I test an outbound payment from a financial account failing?
      - Can I fail an outbound payment that is no longer processing?
      instructions:
      - text: Fail test outbound payment {id}.
        slots:
          id: path.id
      - text: Move processing outbound payment {id} to the failed status.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/outbound_payments/{id}/post'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a test outbound payment
      effect: write
      questions:
      - How do I simulate an outbound payment posting to the recipient in test mode?
      - What does moving a test outbound payment to posted require?
      instructions:
      - text: Mark test outbound payment {id} as posted.
        slots:
          id: path.id
      - text: Settle processing outbound payment {id} to posted.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/outbound_payments/{id}/return'].post
  update:
    x-apievangelist-phrasing:
      intent: Return a test outbound payment
      effect: write
      questions:
      - How do I simulate an outbound payment bouncing back to the financial account?
      - Can I give a return reason when returning a test outbound payment?
      instructions:
      - text: Mark test outbound payment {id} as returned.
        slots:
          id: path.id
      - text: Return outbound payment {id} with details {returned_details}.
        slots:
          id: path.id
          returned_details: requestBody.returned_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail'].post
  update:
    x-apievangelist-phrasing:
      intent: Fail a test outbound transfer
      effect: write
      questions:
      - How do I test an outbound transfer to my own bank account failing?
      - Can I fail a test outbound transfer that is still processing?
      instructions:
      - text: Fail test outbound transfer {outbound_transfer}.
        slots:
          outbound_transfer: path.outbound_transfer
      - text: Move processing outbound transfer {outbound_transfer} to failed.
        slots:
          outbound_transfer: path.outbound_transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a test outbound transfer
      effect: write
      questions:
      - How do I simulate an outbound transfer landing in the destination bank account?
      - Can I move a test outbound transfer straight to posted?
      instructions:
      - text: Mark test outbound transfer {outbound_transfer} as posted.
        slots:
          outbound_transfer: path.outbound_transfer
      - text: Settle processing outbound transfer {outbound_transfer} to posted.
        slots:
          outbound_transfer: path.outbound_transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return'].post
  update:
    x-apievangelist-phrasing:
      intent: Return a test outbound transfer
      effect: write
      questions:
      - How do I simulate an outbound transfer being returned by the receiving bank?
      - Can I include return details on a test outbound transfer?
      instructions:
      - text: Mark test outbound transfer {outbound_transfer} as returned.
        slots:
          outbound_transfer: path.outbound_transfer
      - text: Return outbound transfer {outbound_transfer} with details {returned_details}.
        slots:
          outbound_transfer: path.outbound_transfer
          returned_details: requestBody.returned_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/received_credits'].post
  update:
    x-apievangelist-phrasing:
      intent: Simulate money arriving in a financial account
      effect: write
      questions:
      - How do I simulate a third party sending money into my financial account in test mode?
      - Can I choose the network, like ACH or wire, for a test received credit?
      instructions:
      - text: Simulate a received credit of {amount} {currency} into financial account {financial_account}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
      - text: Send a test {network} credit of {amount} to financial account {financial_account}.
        slots:
          network: requestBody.network
          amount: requestBody.amount
          financial_account: requestBody.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test_helpers/treasury/received_debits'].post
  update:
    x-apievangelist-phrasing:
      intent: Simulate a third-party debit on a financial account
      effect: write
      questions:
      - How do I simulate a third party pulling money out of my financial account in test mode?
      - Can I pick the network for a test received debit?
      instructions:
      - text: Simulate a received debit of {amount} {currency} from financial account {financial_account}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
      - text: Pull a test {network} debit of {amount} from financial account {financial_account}.
        slots:
          network: requestBody.network
          amount: requestBody.amount
          financial_account: requestBody.financial_account
      method: generated
      generated: '2026-09-26'