Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account Crypto Onramp API

4 actions 4 updates phrasing extends openapi/stripe-crypto-onramp-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 4

$.info

$.paths['/v1/crypto/onramp_sessions'].get

$.paths['/v1/crypto/onramp_sessions'].post

$.paths['/v1/crypto/onramp_sessions/{onramp_session}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Accounts Account Crypto Onramp API
  version: 1.0.0
extends: openapi/stripe-crypto-onramp-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: 3
- target: $.paths['/v1/crypto/onramp_sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List crypto onramp sessions
      effect: read
      questions:
      - How do I see the crypto purchase sessions my customers have started?
      - Can I page through all my crypto onramp sessions?
      instructions:
      - text: List my crypto onramp sessions.
      - text: Show the latest {limit} onramp sessions.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/crypto/onramp_sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a session for a customer to buy crypto
      effect: write
      questions:
      - How do I let a customer buy crypto with regular money in my app?
      - Can I prefill the wallet address and stop the customer from changing it?
      - Can I pick the blockchain network the crypto is delivered on?
      instructions:
      - text: Create an onramp session to buy {destination_currency} into wallet {wallet_addresses}.
        slots:
          destination_currency: requestBody.destination_currency
          wallet_addresses: requestBody.wallet_addresses
      - text: Start a session paying {source_amount} {source_currency} for {destination_currency} on {destination_network}.
        slots:
          source_amount: requestBody.source_amount
          source_currency: requestBody.source_currency
          destination_currency: requestBody.destination_currency
          destination_network: requestBody.destination_network
      - text: 'Create an onramp session for {destination_amount} {destination_currency} with the wallet locked: {lock_wallet_address}.'
        slots:
          destination_amount: requestBody.destination_amount
          destination_currency: requestBody.destination_currency
          lock_wallet_address: requestBody.lock_wallet_address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/crypto/onramp_sessions/{onramp_session}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a crypto onramp session
      effect: read
      questions:
      - How do I check whether a customer finished buying crypto?
      - What is the status of a given onramp session?
      instructions:
      - text: Show onramp session {onramp_session}.
        slots:
          onramp_session: path.onramp_session
      - text: Check the status of crypto purchase session {onramp_session}.
        slots:
          onramp_session: path.onramp_session
      method: generated
      generated: '2026-09-26'