Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Charge API

2 actions 2 updates phrasing extends openapi/stax-charge-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Stax's API. It is a proposal applied on top of the contract, not a document Stax publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/charge'].post

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 stax-api Charge API
  version: 1.0.0
extends: openapi/stax-charge-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: 1
- target: $.paths['/charge'].post
  update:
    x-apievangelist-phrasing:
      intent: Charge a saved payment method
      effect: write
      questions:
      - Can I charge a customer's stored card or bank account through Stax?
      - Is it possible to place a pre-authorization instead of an immediate charge on a saved payment method?
      - Can I tie a charge to an invoice and pass an idempotency key so it is not charged twice?
      instructions:
      - text: 'Charge {total} to payment method {payment_method_id} right now, without a pre-auth: {pre_auth}.'
        slots:
          total: requestBody.total
          payment_method_id: requestBody.payment_method_id
          pre_auth: requestBody.pre_auth
      - text: Pre-authorize {total} on payment method {payment_method_id} with pre_auth set to {pre_auth}.
        slots:
          total: requestBody.total
          payment_method_id: requestBody.payment_method_id
          pre_auth: requestBody.pre_auth
      - text: Charge {total} to payment method {payment_method_id} against invoice {invoice_id} using idempotency key {idempotency_id}, pre_auth {pre_auth}.
        slots:
          total: requestBody.total
          payment_method_id: requestBody.payment_method_id
          invoice_id: requestBody.invoice_id
          idempotency_id: requestBody.idempotency_id
          pre_auth: requestBody.pre_auth
      method: generated
      generated: '2026-09-26'