PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Cards API

6 actions 6 updates phrasing extends openapi/payjp-cards-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 6

$.info
$.paths['/customers/{id}/cards'].get
$.paths['/customers/{id}/cards'].post
$.paths['/customers/{id}/cards/{card_id}'].get
$.paths['/customers/{id}/cards/{card_id}'].post
$.paths['/customers/{id}/cards/{card_id}'].delete

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 Cards API
  version: 1.0.0
extends: openapi/payjp-cards-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['/customers/{id}/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's saved cards
      effect: read
      questions:
      - Which cards does this customer have on file?
      - How do I see every card saved to a customer?
      instructions:
      - text: List the cards saved to customer {id}.
        slots:
          id: path.id
      - text: Show all cards on file for customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{id}/cards'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a card to a customer
      effect: write
      questions:
      - How do I save a new card to an existing customer using a token?
      - Can a customer have more than one card attached?
      instructions:
      - text: Attach card token {card} to customer {id}.
        slots:
          card: requestBody.card
          id: path.id
      - text: Save token {card} as a new card on customer {id}.
        slots:
          card: requestBody.card
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{id}/cards/{card_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of a customer's cards
      effect: read
      questions:
      - How do I look up a specific saved card for a customer?
      - What details are stored for one card on a customer?
      instructions:
      - text: Show card {card_id} for customer {id}.
        slots:
          card_id: path.card_id
          id: path.id
      - text: Get saved card {card_id} of customer {id}.
        slots:
          card_id: path.card_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{id}/cards/{card_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's saved card
      effect: write
      questions:
      - How do I change the details of a card already saved on a customer?
      - Can I edit a stored card instead of deleting and re-adding it?
      instructions:
      - text: Update card {card_id} on customer {id}.
        slots:
          card_id: path.card_id
          id: path.id
      - text: Edit the saved card {card_id} belonging to customer {id}.
        slots:
          card_id: path.card_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{id}/cards/{card_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a card from a customer
      effect: destructive
      questions:
      - How do I remove a saved card from a customer?
      - What happens when I delete one of a customer's cards?
      instructions:
      - text: Delete card {card_id} from customer {id}.
        slots:
          card_id: path.card_id
          id: path.id
      - text: Remove saved card {card_id} from customer {id}'s account.
        slots:
          card_id: path.card_id
          id: path.id
      method: generated
      generated: '2026-09-26'