Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Treasury API

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

$.info
$.paths['/v1/treasury/credit_reversals'].get
$.paths['/v1/treasury/credit_reversals'].post
$.paths['/v1/treasury/credit_reversals/{credit_reversal}'].get
$.paths['/v1/treasury/debit_reversals'].get
$.paths['/v1/treasury/debit_reversals'].post
$.paths['/v1/treasury/debit_reversals/{debit_reversal}'].get
$.paths['/v1/treasury/financial_accounts'].get
$.paths['/v1/treasury/financial_accounts'].post
$.paths['/v1/treasury/financial_accounts/{financial_account}'].get
$.paths['/v1/treasury/financial_accounts/{financial_account}'].post
$.paths['/v1/treasury/financial_accounts/{financial_account}/features'].get
$.paths['/v1/treasury/financial_accounts/{financial_account}/features'].post
$.paths['/v1/treasury/inbound_transfers'].get
$.paths['/v1/treasury/inbound_transfers'].post
$.paths['/v1/treasury/inbound_transfers/{id}'].get

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 Treasury API
  version: 1.0.0
extends: openapi/stripe-treasury-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: 32
- target: $.paths['/v1/treasury/credit_reversals'].get
  update:
    x-apievangelist-phrasing:
      intent: List credit reversals on a financial account
      effect: read
      questions:
      - How do I see which incoming credits I've sent back to the sender?
      - Can I filter credit reversals by the received credit they reversed?
      - Which credit reversals on my treasury account are still processing?
      instructions:
      - text: List credit reversals for financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show credit reversals with status {status} on financial account {financial_account}.
        slots:
          status: query.status
          financial_account: query.financial_account
      - text: Find the reversal of received credit {received_credit}.
        slots:
          received_credit: query.received_credit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/credit_reversals'].post
  update:
    x-apievangelist-phrasing:
      intent: Reverse a received credit
      effect: write
      questions:
      - How do I send an incoming credit back to where it came from?
      - Can I return money that was pushed into my treasury financial account?
      instructions:
      - text: Reverse received credit {received_credit}.
        slots:
          received_credit: requestBody.received_credit
      - text: Return the funds from received credit {received_credit} and tag it with {metadata}.
        slots:
          received_credit: requestBody.received_credit
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/credit_reversals/{credit_reversal}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credit reversal
      effect: read
      questions:
      - How do I check the status of a single credit reversal?
      - What details are recorded on a credit reversal after I create it?
      instructions:
      - text: Show credit reversal {credit_reversal}.
        slots:
          credit_reversal: path.credit_reversal
      - text: Check whether credit reversal {credit_reversal} has posted.
        slots:
          credit_reversal: path.credit_reversal
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/debit_reversals'].get
  update:
    x-apievangelist-phrasing:
      intent: List debit reversals on a financial account
      effect: read
      questions:
      - How do I see the pulled debits I've disputed or reversed?
      - Can I filter debit reversals by how they were resolved?
      - Which debit reversals are tied to a specific received debit?
      instructions:
      - text: List debit reversals for financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show debit reversals with resolution {resolution} on financial account {financial_account}.
        slots:
          resolution: query.resolution
          financial_account: query.financial_account
      - text: Find the reversal of received debit {received_debit}.
        slots:
          received_debit: query.received_debit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/debit_reversals'].post
  update:
    x-apievangelist-phrasing:
      intent: Reverse a received debit
      effect: write
      questions:
      - How do I reverse a debit someone pulled from my treasury account?
      - Can I claw back funds that were debited from my financial account?
      instructions:
      - text: Reverse received debit {received_debit}.
        slots:
          received_debit: requestBody.received_debit
      - text: Dispute received debit {received_debit} and note {metadata} on the reversal.
        slots:
          received_debit: requestBody.received_debit
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/debit_reversals/{debit_reversal}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a debit reversal
      effect: read
      questions:
      - How do I look up one debit reversal and its outcome?
      - Has my debit reversal been resolved yet?
      instructions:
      - text: Show debit reversal {debit_reversal}.
        slots:
          debit_reversal: path.debit_reversal
      - text: Check the resolution of debit reversal {debit_reversal}.
        slots:
          debit_reversal: path.debit_reversal
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/financial_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List treasury financial accounts
      effect: read
      questions:
      - How do I see all the treasury financial accounts on my platform?
      - Can I list financial accounts created within a date range?
      instructions:
      - text: List my treasury financial accounts.
      - text: List financial accounts created in {created}.
        slots:
          created: query.created
      - text: Show the first {limit} financial accounts.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/financial_accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a treasury financial account
      effect: write
      questions:
      - How do I open a financial account to hold money for a connected account?
      - Can a connected account have more than one financial account?
      - Which currencies can a new financial account support?
      instructions:
      - text: Open a financial account that supports {supported_currencies}.
        slots:
          supported_currencies: requestBody.supported_currencies
      - text: Create a financial account with features {features} in {supported_currencies}.
        slots:
          features: requestBody.features
          supported_currencies: requestBody.supported_currencies
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/financial_accounts/{financial_account}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a treasury financial account
      effect: read
      questions:
      - How do I check the balance and details of one financial account?
      - What does a treasury financial account record look like?
      instructions:
      - text: Show financial account {financial_account}.
        slots:
          financial_account: path.financial_account
      - text: Get the details of financial account {financial_account}.
        slots:
          financial_account: path.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/financial_accounts/{financial_account}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a treasury financial account
      effect: write
      questions:
      - How do I change the settings on an existing financial account?
      - Can I restrict which platform flows a financial account accepts?
      instructions:
      - text: Update metadata on financial account {financial_account} to {metadata}.
        slots:
          financial_account: path.financial_account
          metadata: requestBody.metadata
      - text: Set platform restrictions {platform_restrictions} on financial account {financial_account}.
        slots:
          platform_restrictions: requestBody.platform_restrictions
          financial_account: path.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/financial_accounts/{financial_account}/features'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a financial account's enabled features
      effect: read
      questions:
      - How do I see which features are turned on for a financial account?
      - Is card issuing or ACH enabled on my financial account?
      instructions:
      - text: Show the features on financial account {financial_account}.
        slots:
          financial_account: path.financial_account
      - text: Check which money movement features financial account {financial_account} has.
        slots:
          financial_account: path.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/financial_accounts/{financial_account}/features'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a financial account's features
      effect: write
      questions:
      - How do I turn on outbound payments for a financial account?
      - Can I enable deposit insurance or card issuing on an existing financial account?
      instructions:
      - text: Enable card issuing {card_issuing} on financial account {financial_account}.
        slots:
          card_issuing: requestBody.card_issuing
          financial_account: path.financial_account
      - text: Set outbound payments to {outbound_payments} for financial account {financial_account}.
        slots:
          outbound_payments: requestBody.outbound_payments
          financial_account: path.financial_account
      - text: Turn on inbound transfers {inbound_transfers} for financial account {financial_account}.
        slots:
          inbound_transfers: requestBody.inbound_transfers
          financial_account: path.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/inbound_transfers'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound transfers into a financial account
      effect: read
      questions:
      - How do I see money I've pulled into my financial account from a bank?
      - Which inbound transfers are still processing or failed?
      instructions:
      - text: List inbound transfers for financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show inbound transfers with status {status} on financial account {financial_account}.
        slots:
          status: query.status
          financial_account: query.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/inbound_transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Pull funds into a financial account
      effect: write
      questions:
      - How do I move money from an external bank account into my financial account?
      - Can I set the statement descriptor on an inbound transfer?
      instructions:
      - text: Pull {amount} {currency} into financial account {financial_account} from {origin_payment_method}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
          origin_payment_method: requestBody.origin_payment_method
      - text: Start an inbound transfer of {amount} {currency} to {financial_account} labelled {description}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/inbound_transfers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inbound transfer
      effect: read
      questions:
      - How do I check whether an inbound transfer has arrived?
      - What details does an inbound transfer carry?
      instructions:
      - text: Show inbound transfer {id}.
        slots:
          id: path.id
      - text: Check the status of inbound transfer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/inbound_transfers/{inbound_transfer}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an inbound transfer
      effect: destructive
      questions:
      - How do I stop an inbound transfer I started by mistake?
      - Can I cancel a pull from an external bank before it completes?
      instructions:
      - text: Cancel inbound transfer {inbound_transfer}.
        slots:
          inbound_transfer: path.inbound_transfer
      - text: Stop the pending inbound transfer {inbound_transfer}.
        slots:
          inbound_transfer: path.inbound_transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List outbound payments from a financial account
      effect: read
      questions:
      - How do I see payments I've sent to third parties from my financial account?
      - Can I list outbound payments sent to a specific customer?
      - Which outbound payments have been returned or canceled?
      instructions:
      - text: List outbound payments from financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show outbound payments to customer {customer} from financial account {financial_account}.
        slots:
          customer: query.customer
          financial_account: query.financial_account
      - text: List outbound payments with status {status} from financial account {financial_account}.
        slots:
          status: query.status
          financial_account: query.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a payment to a third party
      effect: write
      questions:
      - How do I pay a vendor from my treasury financial account?
      - Can I send an outbound payment to a customer's saved payment method?
      instructions:
      - text: Pay {amount} {currency} from {financial_account} to payment method {destination_payment_method}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
          destination_payment_method: requestBody.destination_payment_method
      - text: Send {amount} {currency} from {financial_account} to customer {customer}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
          customer: requestBody.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_payments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an outbound payment
      effect: read
      questions:
      - How do I track where an outbound payment is?
      - Has my outbound payment been posted or returned?
      instructions:
      - text: Show outbound payment {id}.
        slots:
          id: path.id
      - text: Check the status of outbound payment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_payments/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an outbound payment
      effect: destructive
      questions:
      - How do I cancel a payment I sent to a third party before it goes out?
      - Can I stop an outbound payment once it's created?
      instructions:
      - text: Cancel outbound payment {id}.
        slots:
          id: path.id
      - text: Stop outbound payment {id} before it's sent.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_transfers'].get
  update:
    x-apievangelist-phrasing:
      intent: List outbound transfers from a financial account
      effect: read
      questions:
      - How do I see transfers I've made from my financial account to my own bank?
      - Which outbound transfers are pending or failed?
      instructions:
      - text: List outbound transfers from financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show outbound transfers with status {status} from financial account {financial_account}.
        slots:
          status: query.status
          financial_account: query.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Move funds out to your own bank account
      effect: write
      questions:
      - How do I transfer money from my financial account to my external bank account?
      - Can I add a statement descriptor to an outbound transfer?
      instructions:
      - text: Transfer {amount} {currency} from {financial_account} to {destination_payment_method}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
          destination_payment_method: requestBody.destination_payment_method
      - text: Move {amount} {currency} out of {financial_account} with statement descriptor {statement_descriptor}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          financial_account: requestBody.financial_account
          statement_descriptor: requestBody.statement_descriptor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_transfers/{outbound_transfer}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an outbound transfer
      effect: read
      questions:
      - How do I check on a single outbound transfer?
      - Has my transfer to my bank account been paid out yet?
      instructions:
      - text: Show outbound transfer {outbound_transfer}.
        slots:
          outbound_transfer: path.outbound_transfer
      - text: Check whether outbound transfer {outbound_transfer} has posted.
        slots:
          outbound_transfer: path.outbound_transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/outbound_transfers/{outbound_transfer}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an outbound transfer
      effect: destructive
      questions:
      - How do I cancel a transfer to my bank before the money leaves?
      - Can I cancel an outbound transfer after the funds are paid out?
      instructions:
      - text: Cancel outbound transfer {outbound_transfer}.
        slots:
          outbound_transfer: path.outbound_transfer
      - text: Stop outbound transfer {outbound_transfer} before it pays out.
        slots:
          outbound_transfer: path.outbound_transfer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/received_credits'].get
  update:
    x-apievangelist-phrasing:
      intent: List money received into a financial account
      effect: read
      questions:
      - How do I see incoming funds that landed in my financial account?
      - Can I filter received credits by the flow that created them?
      instructions:
      - text: List received credits for financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show received credits with status {status} on financial account {financial_account}.
        slots:
          status: query.status
          financial_account: query.financial_account
      - text: List received credits on {financial_account} linked to {linked_flows}.
        slots:
          financial_account: query.financial_account
          linked_flows: query.linked_flows
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/received_credits/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a received credit
      effect: read
      questions:
      - How do I look up one incoming credit and where it came from?
      - What details does a received credit include?
      instructions:
      - text: Show received credit {id}.
        slots:
          id: path.id
      - text: Get the details of incoming credit {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/received_debits'].get
  update:
    x-apievangelist-phrasing:
      intent: List money pulled from a financial account
      effect: read
      questions:
      - How do I see debits that external parties pulled from my financial account?
      - Which received debits failed on my financial account?
      instructions:
      - text: List received debits for financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show received debits with status {status} on financial account {financial_account}.
        slots:
          status: query.status
          financial_account: query.financial_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/received_debits/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a received debit
      effect: read
      questions:
      - How do I look up one debit pulled from my financial account?
      - Who initiated this received debit and did it succeed?
      instructions:
      - text: Show received debit {id}.
        slots:
          id: path.id
      - text: Get the details of pulled debit {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/transaction_entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List ledger entries on a financial account
      effect: read
      questions:
      - How do I see the individual balance changes on my financial account?
      - Can I list transaction entries by effective date?
      - Which ledger entries belong to one treasury transaction?
      instructions:
      - text: List transaction entries for financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show ledger entries on {financial_account} effective in {effective_at}.
        slots:
          financial_account: query.financial_account
          effective_at: query.effective_at
      - text: List entries for treasury transaction {transaction}.
        slots:
          transaction: query.transaction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/transaction_entries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ledger entry
      effect: read
      questions:
      - How do I look up one balance change on my financial account?
      - What does a single transaction entry show?
      instructions:
      - text: Show transaction entry {id}.
        slots:
          id: path.id
      - text: Get the details of ledger entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions on a financial account
      effect: read
      questions:
      - How do I see all money movement on my treasury financial account?
      - Can I list only posted or voided treasury transactions?
      instructions:
      - text: List transactions for financial account {financial_account}.
        slots:
          financial_account: query.financial_account
      - text: Show transactions with status {status} on financial account {financial_account}.
        slots:
          status: query.status
          financial_account: query.financial_account
      - text: List transactions on {financial_account} created in {created}.
        slots:
          financial_account: query.financial_account
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/treasury/transactions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a treasury transaction
      effect: read
      questions:
      - How do I look up one treasury transaction and its status?
      - What flow created this transaction on my financial account?
      instructions:
      - text: Show treasury transaction {id}.
        slots:
          id: path.id
      - text: Look up the money movement recorded as transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'