PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Transfers API

4 actions 4 updates phrasing extends openapi/payjp-transfers-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 4

$.info
$.paths['/transfers'].get
$.paths['/transfers/{id}'].get
$.paths['/transfers/{id}/details'].get

OpenAPI Overlay

Raw ↑ 
# 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 Transfers API
  version: 1.0.0
extends: openapi/payjp-transfers-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['/transfers'].get
  update:
    x-apievangelist-phrasing:
      intent: List payouts
      effect: read
      questions:
      - When have I been paid out to my bank account?
      - How do I see all my deposits?
      instructions:
      - text: List my payouts.
      - text: Show every transfer to my bank account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transfers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payout
      effect: read
      questions:
      - How do I look up one payout's amount and date?
      - What's the status of a particular transfer?
      instructions:
      - text: Show transfer {id}.
        slots:
          id: path.id
      - text: Get the details of payout {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transfers/{id}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: List the charges in a payout
      effect: read
      questions:
      - Which charges were settled in a specific payout?
      - Can I break a transfer down into its individual charges?
      instructions:
      - text: List the charges settled in transfer {id}.
        slots:
          id: path.id
      - text: Break payout {id} down into its charges.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'