PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Platform API

8 actions 8 updates phrasing extends openapi/payjp-platform-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/tenants'].get

$.paths['/tenants'].post

$.paths['/tenants/{id}'].get

$.paths['/tenants/{id}'].post

$.paths['/tenants/{id}'].delete

$.paths['/tenant_transfers'].get

$.paths['/tenant_transfers/{id}'].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 PAY.JP Platform API
  version: 1.0.0
extends: openapi/payjp-platform-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: 7
- target: $.paths['/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List platform tenants
      effect: read
      questions:
      - Which sub-merchants are registered under my platform?
      - How do I see all my platform tenants?
      instructions:
      - text: List my platform tenants.
      - text: Show every sub-merchant on my platform.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sub-merchant tenant
      effect: write
      questions:
      - How do I onboard a new sub-merchant onto my platform?
      - Can I create tenants through the API while the platform feature is in beta?
      instructions:
      - text: Create a new platform tenant.
      - text: Register a new sub-merchant on my platform.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a platform tenant
      effect: read
      questions:
      - How do I look up one sub-merchant's tenant record?
      - What details are stored for a particular tenant?
      instructions:
      - text: Show tenant {id}.
        slots:
          id: path.id
      - text: Get the details of sub-merchant tenant {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a platform tenant
      effect: write
      questions:
      - How do I change a sub-merchant's tenant details?
      - Can I edit a tenant after onboarding them?
      instructions:
      - text: Update tenant {id}.
        slots:
          id: path.id
      - text: Edit sub-merchant tenant {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a platform tenant
      effect: destructive
      questions:
      - How do I remove a sub-merchant from my platform?
      - What happens when I delete a tenant?
      instructions:
      - text: Delete tenant {id}.
        slots:
          id: path.id
      - text: Remove sub-merchant tenant {id} from my platform.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant_transfers'].get
  update:
    x-apievangelist-phrasing:
      intent: List payouts to tenants
      effect: read
      questions:
      - How do I see the payouts made to my sub-merchants?
      - Which tenant transfers has my platform generated?
      instructions:
      - text: List my tenant transfers.
      - text: Show every payout to platform tenants.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant_transfers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant transfer
      effect: read
      questions:
      - How do I check the details of one payout to a sub-merchant?
      - What went into a specific tenant transfer?
      instructions:
      - text: Show tenant transfer {id}.
        slots:
          id: path.id
      - text: Get the details of sub-merchant payout {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'