# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Payment Intents API
  version: 1.0.0
extends: openapi/stripe-payment-intents-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: 11
- target: $.paths['/v1/payment_intents'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments in progress and completed
      effect: read
      questions:
      - How do I list recent PaymentIntents on my account?
      - Can I see only the PaymentIntents for one customer?
      - How do I pull the PaymentIntents created during a specific time window?
      instructions:
      - text: List my most recent PaymentIntents.
      - text: List the PaymentIntents for customer {customer}.
        slots:
          customer: query.customer
      - text: Show up to {limit} PaymentIntents created {created}.
        slots:
          limit: query.limit
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a payment for an amount
      effect: write
      questions:
      - How do I start collecting a payment from a customer in Stripe?
      - Can I authorize a card now and capture the money later?
      - Can I create and confirm a payment in one call?
      - How do I save the customer's payment method for future charges while taking a payment?
      instructions:
      - text: Create a PaymentIntent for {amount} {currency}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
      - text: Charge customer {customer} {amount} {currency} with payment method {payment_method} and confirm it now.
        slots:
          customer: requestBody.customer
          amount: requestBody.amount
          currency: requestBody.currency
          payment_method: requestBody.payment_method
      - text: Start a {amount} {currency} payment that only authorizes, using capture method {capture_method}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          capture_method: requestBody.capture_method
      - text: Create a {amount} {currency} payment and email the receipt to {receipt_email}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          receipt_email: requestBody.receipt_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search payments with a query
      effect: read
      questions:
      - How do I search for payments by status, amount or metadata?
      - How quickly does a new payment show up in search results?
      - Should I use search right after creating a payment?
      instructions:
      - text: Search PaymentIntents matching {query}.
        slots:
          query: query.query
      - text: Find payments where {query} and return {limit} results.
        slots:
          query: query.query
          limit: query.limit
      - text: Get the next page {page} of PaymentIntent search results for {query}.
        slots:
          page: query.page
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a PaymentIntent
      effect: read
      questions:
      - How do I check the status of one payment?
      - Can my front end fetch a PaymentIntent with a publishable key?
      instructions:
      - text: Show PaymentIntent {intent}.
        slots:
          intent: path.intent
      - text: Fetch PaymentIntent {intent} client-side using secret {client_secret}.
        slots:
          intent: path.intent
          client_secret: query.client_secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a payment before it is confirmed
      effect: write
      questions:
      - How do I change the amount of a payment before the customer pays?
      - Do I need to confirm a PaymentIntent again after switching its payment method?
      instructions:
      - text: Change the amount on PaymentIntent {intent} to {amount}.
        slots:
          intent: path.intent
          amount: requestBody.amount
      - text: Attach customer {customer} to PaymentIntent {intent}.
        slots:
          customer: requestBody.customer
          intent: path.intent
      - text: Update the description on PaymentIntent {intent} to {description}.
        slots:
          intent: path.intent
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}/apply_customer_balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay a PaymentIntent from the customer's cash balance
      effect: write
      questions:
      - How do I use money in a customer's cash balance to settle a payment?
      - Can I apply only part of the customer's cash balance to a payment?
      instructions:
      - text: Apply the customer's cash balance to PaymentIntent {intent}.
        slots:
          intent: path.intent
      - text: Apply {amount} {currency} of cash balance to PaymentIntent {intent}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          intent: path.intent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a payment
      effect: destructive
      questions:
      - How do I cancel a payment the customer hasn't finished?
      - What happens to an authorized but uncaptured amount when I cancel?
      - Can I record why I canceled a payment, like fraud or duplicate?
      instructions:
      - text: Cancel PaymentIntent {intent}.
        slots:
          intent: path.intent
      - text: Cancel payment {intent} with reason {cancellation_reason}.
        slots:
          intent: path.intent
          cancellation_reason: requestBody.cancellation_reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}/capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture an authorized payment
      effect: write
      questions:
      - How do I collect the money from a payment I only authorized?
      - Can I capture less than the amount I authorized?
      - How long do I have to capture an authorized payment before it's canceled?
      instructions:
      - text: Capture PaymentIntent {intent}.
        slots:
          intent: path.intent
      - text: Capture {amount_to_capture} of authorized payment {intent}.
        slots:
          amount_to_capture: requestBody.amount_to_capture
          intent: path.intent
      - text: Capture part of payment {intent} and keep the rest authorized with final capture {final_capture}.
        slots:
          intent: path.intent
          final_capture: requestBody.final_capture
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a payment and attempt the charge
      effect: write
      questions:
      - How do I confirm a payment so the customer is actually charged?
      - What happens if the customer's bank requires extra authentication?
      - Can I charge a saved card when the customer isn't in my checkout?
      instructions:
      - text: Confirm PaymentIntent {intent}.
        slots:
          intent: path.intent
      - text: Confirm payment {intent} with payment method {payment_method}.
        slots:
          intent: path.intent
          payment_method: requestBody.payment_method
      - text: Confirm payment {intent} and send the customer back to {return_url} after authentication.
        slots:
          intent: path.intent
          return_url: requestBody.return_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}/increment_authorization'].post
  update:
    x-apievangelist-phrasing:
      intent: Increase the authorized amount on a card payment
      effect: write
      questions:
      - How do I raise the amount held on a customer's card before capturing?
      - Can an incremental authorization be declined?
      - Which payments are eligible for an incremental authorization?
      instructions:
      - text: Increase the authorization on PaymentIntent {intent} to {amount}.
        slots:
          intent: path.intent
          amount: requestBody.amount
      - text: Raise the held amount on payment {intent} to {amount} with note {description}.
        slots:
          intent: path.intent
          amount: requestBody.amount
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_intents/{intent}/verify_microdeposits'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify bank microdeposits for a payment
      effect: write
      questions:
      - How do I verify a customer's bank account with microdeposits before a payment?
      - Can I verify microdeposits with the descriptor code instead of the two amounts?
      instructions:
      - text: Verify microdeposits on PaymentIntent {intent} with amounts {amounts}.
        slots:
          intent: path.intent
          amounts: requestBody.amounts
      - text: Verify the bank account on payment {intent} using descriptor code {descriptor_code}.
        slots:
          intent: path.intent
          descriptor_code: requestBody.descriptor_code
      method: generated
      generated: '2026-09-26'