Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Verify API

2 actions 2 updates phrasing extends openapi/stax-verify-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['/verify'].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 Verify API
  version: 1.0.0
extends: openapi/stax-verify-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['/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a saved payment method
      effect: write
      questions:
      - Can I check that a customer's saved card is good before charging it for real?
      - What amount is needed to run a verification on a stored payment method?
      instructions:
      - text: Verify payment method {payment_method_id} with a {total} check.
        slots:
          payment_method_id: requestBody.payment_method_id
          total: requestBody.total
      - text: Run a {total} verification on payment method {payment_method_id} with metadata {meta}.
        slots:
          total: requestBody.total
          payment_method_id: requestBody.payment_method_id
          meta: requestBody.meta
      method: generated
      generated: '2026-09-26'