Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Underwriting API

6 actions 6 updates phrasing extends openapi/stax-underwriting-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 6

$.info

$.paths['/underwriting/merchant/{id}/registration/documents'].get

$.paths['/underwriting/disputes/{merchantId}'].get

$.paths['/underwriting/disputes'].get

$.paths['/underwriting/terms-and-conditions/{id}'].get

$.paths['/underwriting/dispute/{disputeId}/submit'].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 Underwriting API
  version: 1.0.0
extends: openapi/stax-underwriting-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: 5
- target: $.paths['/underwriting/merchant/{id}/registration/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a merchant's required registration documents
      effect: read
      questions:
      - Which documents does a merchant still need to supply for underwriting?
      - Can I group a merchant's registration documents by type?
      instructions:
      - text: Get the registration documents required for merchant {id}.
        slots:
          id: path.id
      - text: Show merchant {id}'s registration documents of type {type}.
        slots:
          id: path.id
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/underwriting/disputes/{merchantId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List disputes for a specific merchant
      effect: read
      questions:
      - Which chargebacks has one of my sub-merchants received?
      - Can I filter another merchant's disputes by status or reason?
      instructions:
      - text: List disputes for merchant {merchantId}.
        slots:
          merchantId: path.merchantId
      - text: Show merchant {merchantId}'s disputes with status {status}.
        slots:
          merchantId: path.merchantId
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/underwriting/disputes'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own disputes
      effect: read
      questions:
      - What chargebacks has my account received?
      - Can I find the dispute for a particular transaction on my account?
      instructions:
      - text: List my disputes.
      - text: Find my dispute for transaction {transaction_id}.
        slots:
          transaction_id: query.transaction_id
      - text: Show my disputes opened between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/underwriting/terms-and-conditions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a merchant's terms and conditions
      effect: read
      questions:
      - What terms and conditions apply to a given merchant?
      - Can I retrieve the T&Cs a merchant agreed to?
      instructions:
      - text: Get the terms and conditions for merchant {id}.
        slots:
          id: path.id
      - text: Show the T&Cs on file for merchant {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/underwriting/dispute/{disputeId}/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit dispute evidence for review
      effect: write
      questions:
      - Once my evidence is uploaded, how do I send the dispute for review?
      - Can I submit all of a chargeback's evidence files at once?
      instructions:
      - text: Submit the evidence for dispute {disputeId} for review.
        slots:
          disputeId: path.disputeId
      - text: Send all uploaded evidence files on dispute {disputeId} to review.
        slots:
          disputeId: path.disputeId
      method: generated
      generated: '2026-09-26'