API Evangelist conversational phrasing for stax-api Payment Method API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for stax-api Payment Method API
  version: 1.0.0
extends: openapi/stax-payment-method-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: 7
- target: $.paths['/payment-method'].get
  update:
    x-apievangelist-phrasing:
      intent: List all payment methods on the merchant
      effect: read
      questions:
      - Which saved cards and bank accounts exist across all of my customers?
      - Can I find payment methods that the card account updater changed recently?
      instructions:
      - text: List every saved payment method on my merchant account.
      - text: Show payment methods with account updater event {au_last_event} between {au_last_event_start_at} and {au_last_event_end_at}.
        slots:
          au_last_event: query.au_last_event
          au_last_event_start_at: query.au_last_event_start_at
          au_last_event_end_at: query.au_last_event_end_at
      - text: List merchant payment methods with status {status}, {per_page} per page.
        slots:
          status: query.status
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payment-method'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a bank account (ACH) payment method
      effect: write
      questions:
      - How do I tokenize a customer's bank account for ACH payments?
      - What bank details are required to save a checking or savings account for a customer?
      instructions:
      - text: 'Save bank account {bank_account}/{bank_routing} at {bank_name} for customer {customer_id}: {person_name}, {method}, {bank_type}, {bank_holder_type}.'
        slots:
          bank_account: requestBody.bank_account
          bank_routing: requestBody.bank_routing
          bank_name: requestBody.bank_name
          customer_id: requestBody.customer_id
          person_name: requestBody.person_name
          method: requestBody.method
          bank_type: requestBody.bank_type
          bank_holder_type: requestBody.bank_holder_type
      - text: 'Add an ACH {bank_type} account for customer {customer_id}: {bank_account}/{bank_routing}, {bank_name}, {person_name}, {bank_holder_type}, {method}.'
        slots:
          bank_type: requestBody.bank_type
          customer_id: requestBody.customer_id
          bank_account: requestBody.bank_account
          bank_routing: requestBody.bank_routing
          bank_name: requestBody.bank_name
          person_name: requestBody.person_name
          bank_holder_type: requestBody.bank_holder_type
          method: requestBody.method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payment-method/'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a credit or debit card payment method
      effect: write
      questions:
      - Can I tokenize a customer's credit card directly through the API?
      - What card details are needed to store a debit card on file for a customer?
      instructions:
      - text: Save card {card_number} exp {card_exp} CVV {card_cvv} ({card_type}) for customer {customer_id}, cardholder {person_name}, method {method}.
        slots:
          card_number: requestBody.card_number
          card_exp: requestBody.card_exp
          card_cvv: requestBody.card_cvv
          card_type: requestBody.card_type
          customer_id: requestBody.customer_id
          person_name: requestBody.person_name
          method: requestBody.method
      - text: Store {person_name}'s {card_type} card {card_number}, {card_exp}, {card_cvv} on customer {customer_id} as {method}.
        slots:
          person_name: requestBody.person_name
          card_type: requestBody.card_type
          card_number: requestBody.card_number
          card_exp: requestBody.card_exp
          card_cvv: requestBody.card_cvv
          customer_id: requestBody.customer_id
          method: requestBody.method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payment-method/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment method
      effect: read
      questions:
      - What card brand and last four digits are on a specific saved payment method?
      - Can I look up one payment method by its ID?
      instructions:
      - text: Get payment method {id}.
        slots:
          id: path.id
      - text: Show the details of saved payment method {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payment-method/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved payment method
      effect: write
      questions:
      - Can I change the expiration date on a card that is already saved?
      - Is it possible to make an existing payment method the customer's default?
      instructions:
      - text: Update the card expiration on payment method {id} to {card_exp}.
        slots:
          id: path.id
          card_exp: query.card_exp
      - text: 'Make payment method {id} the default: {is_default}.'
        slots:
          id: path.id
          is_default: query.is_default
      - text: Change the billing zip on payment method {id} to {address_zip}.
        slots:
          id: path.id
          address_zip: query.address_zip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payment-method/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer's payment method
      effect: destructive
      questions:
      - Can I remove a card a customer no longer wants on file?
      - What happens when a saved bank account is deleted?
      instructions:
      - text: Delete payment method {id}.
        slots:
          id: path.id
      - text: Remove saved payment method {id} from the customer.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payment_method/{payment_method_id}/external_vault'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a payment method to an external gateway
      effect: write
      questions:
      - Can I copy a stored Stax card into another payment gateway's vault?
      - Is it possible to share a saved payment method with a third-party gateway using its token?
      instructions:
      - text: Copy payment method {payment_method_id} to the external vault with gateway token {gateway_token}.
        slots:
          payment_method_id: path.payment_method_id
          gateway_token: query.gateway_token
      - text: Share payment method {payment_method_id} with an external gateway.
        slots:
          payment_method_id: path.payment_method_id
      method: generated
      generated: '2026-09-26'