Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Issuing API

28 actions 28 updates phrasing extends openapi/stripe-issuing-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 28 · first 16 shown; the file carries all of them

$.info
$.paths['/v1/issuing/authorizations'].get
$.paths['/v1/issuing/authorizations/{authorization}'].get
$.paths['/v1/issuing/authorizations/{authorization}'].post
$.paths['/v1/issuing/authorizations/{authorization}/approve'].post
$.paths['/v1/issuing/authorizations/{authorization}/decline'].post
$.paths['/v1/issuing/cardholders'].get
$.paths['/v1/issuing/cardholders'].post
$.paths['/v1/issuing/cardholders/{cardholder}'].get
$.paths['/v1/issuing/cardholders/{cardholder}'].post
$.paths['/v1/issuing/cards'].get
$.paths['/v1/issuing/cards'].post
$.paths['/v1/issuing/cards/{card}'].get
$.paths['/v1/issuing/cards/{card}'].post
$.paths['/v1/issuing/disputes'].get
$.paths['/v1/issuing/disputes'].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 Issuing API
  version: 1.0.0
extends: openapi/stripe-issuing-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: 27
- target: $.paths['/v1/issuing/authorizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List card authorization requests
      effect: read
      questions:
      - How do I see every authorization attempt made on the cards I've issued?
      - Can I filter issued-card authorizations by cardholder or by status like pending or closed?
      - Which purchases were attempted on one specific issued card?
      instructions:
      - text: List the latest authorizations on issued cards.
      - text: Show authorizations on card {card} with status {status}.
        slots:
          card: query.card
          status: query.status
      - text: List authorizations for cardholder {cardholder}.
        slots:
          cardholder: query.cardholder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/authorizations/{authorization}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one card authorization
      effect: read
      questions:
      - How do I pull up the details of a single authorization on an issued card?
      - What did one specific issued-card authorization look like when it came in?
      instructions:
      - text: Get authorization {authorization}.
        slots:
          authorization: path.authorization
      - text: Show me the details of issued-card authorization {authorization}.
        slots:
          authorization: path.authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/authorizations/{authorization}'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a card authorization with metadata
      effect: write
      questions:
      - Can I attach my own reference data to an issued-card authorization?
      - How do I label an authorization so my accounting system can match it later?
      instructions:
      - text: Add metadata {metadata} to authorization {authorization}.
        slots:
          metadata: requestBody.metadata
          authorization: path.authorization
      - text: Update the metadata on issued-card authorization {authorization}.
        slots:
          authorization: path.authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/authorizations/{authorization}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a pending card authorization
      effect: write
      questions:
      - How do I approve a pending purchase on one of my issued cards in real time?
      - Can I approve an issued-card authorization for less than the requested amount?
      - Is the approve endpoint for issued-card authorizations still recommended, or is it deprecated?
      instructions:
      - text: Approve pending authorization {authorization}.
        slots:
          authorization: path.authorization
      - text: Approve authorization {authorization} for {amount} only.
        slots:
          authorization: path.authorization
          amount: requestBody.amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/authorizations/{authorization}/decline'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline a pending card authorization
      effect: destructive
      questions:
      - How do I decline a purchase attempt on an issued card before it goes through?
      - Is there a time window for declining a pending issued-card authorization?
      instructions:
      - text: Decline pending authorization {authorization}.
        slots:
          authorization: path.authorization
      - text: Reject the purchase attempt on authorization {authorization} and note why in metadata {metadata}.
        slots:
          authorization: path.authorization
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cardholders'].get
  update:
    x-apievangelist-phrasing:
      intent: List cardholders
      effect: read
      questions:
      - How do I see all the people and companies I've set up to receive issued cards?
      - Can I find a cardholder by email or phone number?
      - Which cardholders are individuals versus companies?
      instructions:
      - text: List all my cardholders.
      - text: Find the cardholder with email {email}.
        slots:
          email: query.email
      - text: List cardholders with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cardholders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cardholder
      effect: write
      questions:
      - How do I register a person or company so I can issue them a card?
      - What billing address details does a new cardholder need?
      - Can I set spending limits for a cardholder when I create them?
      instructions:
      - text: Create a cardholder named {name} with email {email} and billing address {billing}.
        slots:
          name: requestBody.name
          email: requestBody.email
          billing: requestBody.billing
      - text: Add a new {type} cardholder called {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create cardholder {name} with spending controls {spending_controls}.
        slots:
          name: requestBody.name
          spending_controls: requestBody.spending_controls
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cardholders/{cardholder}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a cardholder
      effect: read
      questions:
      - How do I view the profile and billing details of one cardholder?
      - What spending controls are set on a particular cardholder?
      instructions:
      - text: Get cardholder {cardholder}.
        slots:
          cardholder: path.cardholder
      - text: Show me the details for cardholder {cardholder}.
        slots:
          cardholder: path.cardholder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cardholders/{cardholder}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a cardholder
      effect: write
      questions:
      - How do I change a cardholder's email, phone or billing address?
      - Can I deactivate a cardholder or change their spending limits?
      instructions:
      - text: Change the email of cardholder {cardholder} to {email}.
        slots:
          cardholder: path.cardholder
          email: requestBody.email
      - text: Set cardholder {cardholder} status to {status}.
        slots:
          cardholder: path.cardholder
          status: requestBody.status
      - text: Update spending controls on cardholder {cardholder} to {spending_controls}.
        slots:
          cardholder: path.cardholder
          spending_controls: requestBody.spending_controls
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List issued cards
      effect: read
      questions:
      - How do I see every card I've issued?
      - Can I find an issued card by its last four digits or expiry date?
      - Which issued cards are physical versus virtual, or currently inactive?
      instructions:
      - text: List all my issued cards.
      - text: Find the issued card ending in {last4}.
        slots:
          last4: query.last4
      - text: List cards for cardholder {cardholder} with status {status}.
        slots:
          cardholder: query.cardholder
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cards'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a new card
      effect: write
      questions:
      - How do I issue a virtual or physical card to a cardholder?
      - Can I issue a replacement for a lost or stolen card?
      - Where do I set the shipping address for a physical card?
      instructions:
      - text: Issue a {type} card in {currency} to cardholder {cardholder}.
        slots:
          type: requestBody.type
          currency: requestBody.currency
          cardholder: requestBody.cardholder
      - text: Issue a replacement for card {replacement_for} because it was {replacement_reason}.
        slots:
          replacement_for: requestBody.replacement_for
          replacement_reason: requestBody.replacement_reason
      - text: Ship a physical card for cardholder {cardholder} to {shipping}.
        slots:
          cardholder: requestBody.cardholder
          shipping: requestBody.shipping
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cards/{card}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an issued card
      effect: read
      questions:
      - How do I check the status and spending controls of one issued card?
      - What details can I see about a single card I issued?
      instructions:
      - text: Get issued card {card}.
        slots:
          card: path.card
      - text: Show me the status of card {card}.
        slots:
          card: path.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/cards/{card}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or freeze an issued card
      effect: write
      questions:
      - How do I freeze or cancel an issued card?
      - Can I change the PIN or spending limits on a card I've already issued?
      - What cancellation reasons can I give when shutting down a card?
      instructions:
      - text: Set card {card} status to {status}.
        slots:
          card: path.card
          status: requestBody.status
      - text: Cancel card {card} as {cancellation_reason}.
        slots:
          card: path.card
          cancellation_reason: requestBody.cancellation_reason
      - text: Change spending controls on card {card} to {spending_controls}.
        slots:
          card: path.card
          spending_controls: requestBody.spending_controls
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/disputes'].get
  update:
    x-apievangelist-phrasing:
      intent: List issued-card disputes
      effect: read
      questions:
      - How do I see all the disputes I've opened on issued-card transactions?
      - Can I filter my issued-card disputes by status, like submitted or won?
      instructions:
      - text: List my issued-card disputes.
      - text: Show disputes with status {status}.
        slots:
          status: query.status
      - text: Find the dispute for transaction {transaction}.
        slots:
          transaction: query.transaction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/disputes'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a dispute on a card transaction
      effect: write
      questions:
      - How do I dispute a charge made on one of my issued cards?
      - Do I need all the evidence ready before I open an issued-card dispute?
      - Can I dispute only part of a transaction amount?
      instructions:
      - text: Open a dispute on transaction {transaction}.
        slots:
          transaction: requestBody.transaction
      - text: Dispute {amount} of transaction {transaction} with evidence {evidence}.
        slots:
          amount: requestBody.amount
          transaction: requestBody.transaction
          evidence: requestBody.evidence
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/disputes/{dispute}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an issued-card dispute
      effect: read
      questions:
      - How do I check where one of my issued-card disputes stands?
      - What evidence is currently attached to a dispute I opened?
      instructions:
      - text: Get issued-card dispute {dispute}.
        slots:
          dispute: path.dispute
      - text: Show me the status and evidence of dispute {dispute}.
        slots:
          dispute: path.dispute
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/disputes/{dispute}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update evidence on a card dispute
      effect: write
      questions:
      - How do I add or change evidence on an issued-card dispute before submitting it?
      - Can I change the disputed amount after opening the dispute?
      instructions:
      - text: Update the evidence on dispute {dispute} to {evidence}.
        slots:
          dispute: path.dispute
          evidence: requestBody.evidence
      - text: Change the disputed amount on {dispute} to {amount}.
        slots:
          dispute: path.dispute
          amount: requestBody.amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/disputes/{dispute}/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a card dispute to the network
      effect: write
      questions:
      - How do I send an issued-card dispute to the card network once the evidence is ready?
      - What happens if required evidence is missing when I submit a dispute?
      instructions:
      - text: Submit dispute {dispute} to the card network.
        slots:
          dispute: path.dispute
      - text: File issued-card dispute {dispute} now that the evidence is complete.
        slots:
          dispute: path.dispute
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/settlements'].get
  update:
    x-apievangelist-phrasing:
      intent: List issuing settlements
      effect: read
      questions:
      - How do I see the settlements for my card issuing program?
      - Can I list issuing settlements from a specific date range?
      instructions:
      - text: List my recent issuing settlements.
      - text: Show issuing settlements created in {created}.
        slots:
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/settlements/{settlement}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an issuing settlement
      effect: read
      questions:
      - How do I view the details of one issuing settlement?
      - What does a single card-network settlement for my issued cards contain?
      instructions:
      - text: Get issuing settlement {settlement}.
        slots:
          settlement: path.settlement
      - text: Show me settlement {settlement}.
        slots:
          settlement: path.settlement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/settlements/{settlement}'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag an issuing settlement with metadata
      effect: write
      questions:
      - Can I attach my own notes or reference IDs to an issuing settlement?
      - How do I label a settlement for reconciliation?
      instructions:
      - text: Add metadata {metadata} to settlement {settlement}.
        slots:
          metadata: requestBody.metadata
          settlement: path.settlement
      - text: Update the metadata on issuing settlement {settlement}.
        slots:
          settlement: path.settlement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List digital wallet tokens for a card
      effect: read
      questions:
      - How do I see which digital wallets an issued card has been added to?
      - Can I list only the active or suspended tokens on a card?
      instructions:
      - text: List the tokens for card {card}.
        slots:
          card: query.card
      - text: Show tokens on card {card} with status {status}.
        slots:
          card: query.card
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/tokens/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a card token
      effect: read
      questions:
      - How do I get the details of one token created for an issued card?
      - What status is a particular card token in?
      instructions:
      - text: Get issuing token {token}.
        slots:
          token: path.token
      - text: Show me the status of token {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/tokens/{token}'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend or reactivate a card token
      effect: write
      questions:
      - How do I suspend a card token in a digital wallet without cancelling the card?
      - Can I reactivate a suspended token or permanently deactivate it?
      instructions:
      - text: Set token {token} status to {status}.
        slots:
          token: path.token
          status: requestBody.status
      - text: Suspend token {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List issued-card transactions
      effect: read
      questions:
      - How do I see all the completed purchases and refunds on my issued cards?
      - Can I list transactions for a single card or cardholder?
      - How do I tell captures apart from refunds in issuing transactions?
      instructions:
      - text: List recent issued-card transactions.
      - text: List transactions on card {card}.
        slots:
          card: query.card
      - text: Show {type} transactions for cardholder {cardholder}.
        slots:
          type: query.type
          cardholder: query.cardholder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/transactions/{transaction}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an issued-card transaction
      effect: read
      questions:
      - How do I get the details of one purchase made on an issued card?
      - What information is recorded for a single issuing transaction?
      instructions:
      - text: Get issuing transaction {transaction}.
        slots:
          transaction: path.transaction
      - text: Show me the details of card transaction {transaction}.
        slots:
          transaction: path.transaction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/issuing/transactions/{transaction}'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a card transaction with metadata
      effect: write
      questions:
      - Can I attach an expense code or note to an issued-card transaction?
      - How do I label a card transaction for bookkeeping?
      instructions:
      - text: Add metadata {metadata} to transaction {transaction}.
        slots:
          metadata: requestBody.metadata
          transaction: path.transaction
      - text: Update the metadata on issued-card transaction {transaction}.
        slots:
          transaction: path.transaction
      method: generated
      generated: '2026-09-26'