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.
# 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 Tokens API
version: 1.0.0
extends: openapi/payjp-tokens-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['/tokens'].post
update:
x-apievangelist-phrasing:
intent: Tokenize a card
effect: write
questions:
- How do I turn card details into a single-use token?
- Can I avoid raw card numbers touching my server?
instructions:
- text: Create a card token for number {number} expiring {exp_month}/{exp_year}.
slots:
number: requestBody.card[number]
exp_month: requestBody.card[exp_month]
exp_year: requestBody.card[exp_year]
- text: Tokenize card {number}, exp {exp_month}/{exp_year}, CVC {cvc}.
slots:
number: requestBody.card[number]
exp_month: requestBody.card[exp_month]
exp_year: requestBody.card[exp_year]
cvc: requestBody.card[cvc]
method: generated
generated: '2026-09-26'
- target: $.paths['/tokens/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a card token
effect: read
questions:
- How do I check whether a card token has been used?
- What card details can I see from a token?
instructions:
- text: Show token {id}.
slots:
id: path.id
- text: Get the details of card token {id}.
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'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.