# 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 3D Secure API
  version: 1.0.0
extends: openapi/payjp-3d-secure-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['/charges/{id}/tds_finish'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish 3D Secure authentication for a charge
      effect: write
      questions:
      - After the cardholder passes 3D Secure, how do I complete the charge that was waiting on it?
      - What call finalizes a charge once its 3D Secure challenge is done?
      instructions:
      - text: Finish the 3D Secure flow for charge {id}.
        slots:
          id: path.id
      - text: Complete 3D Secure on charge {id} so the payment can proceed.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tokens/{id}/tds_finish'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish 3D Secure authentication for a card token
      effect: write
      questions:
      - Once a cardholder completes 3D Secure on a token, how do I mark the token as authenticated?
      - Is there a step to finalize 3D Secure on a card token before I charge it?
      instructions:
      - text: Finish the 3D Secure flow for token {id}.
        slots:
          id: path.id
      - text: Complete 3D Secure authentication on card token {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/three_d_secure_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List 3D Secure requests
      effect: read
      questions:
      - Which standalone 3D Secure requests have I started for stored cards?
      - Can I see all my 3D Secure authentication requests in one list?
      instructions:
      - text: List my 3D Secure requests.
      - text: Show every 3D Secure request made on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/three_d_secure_requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Start 3D Secure authentication for a stored card
      effect: write
      questions:
      - How do I run 3D Secure on a card that is already saved to a customer?
      - Can I authenticate a stored card with 3D Secure without creating a charge?
      instructions:
      - text: Start a 3D Secure request for card {resource_id}.
        slots:
          resource_id: requestBody.resource_id
      - text: Create a 3D Secure authentication request for stored card {resource_id}.
        slots:
          resource_id: requestBody.resource_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/three_d_secure_requests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a 3D Secure request
      effect: read
      questions:
      - How can I check the status of one particular 3D Secure request?
      - Did the cardholder finish the 3D Secure request I started?
      instructions:
      - text: Show 3D Secure request {id}.
        slots:
          id: path.id
      - text: Get the status of 3D Secure request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'