PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist enhancements for PAY.JP

3 actions 3 updates update extends openapi/payjp-openapi.yml

Derived by API Evangelist Built from the contracts PAY.JP publishes. PAY.JP did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-enrichedx-apievangelist-artifactsx-payjp-currencyx-payjp-authx-payjp-idempotencyx-payjp-paginationx-key-prefixesx-client-side-key

Targets 2

$.info

$.components.securitySchemes.basicAuth

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for PAY.JP
  version: 1.0.0
extends: openapi/payjp-openapi.yml
# Provenance: generated 2026-07-17 by the API Evangelist enrichment pipeline.
# Captures our enrichment metadata as a non-destructive Overlay; the original
# modeled OpenAPI is never mutated. Cross-references the artifacts produced this
# round so downstream tooling can find them from the spec.
actions:
  - target: $.info
    update:
      x-apievangelist-enriched: '2026-07-17'
      x-apievangelist-artifacts:
        authentication: authentication/payjp-authentication.yml
        conventions: conventions/payjp-conventions.yml
        errors: errors/payjp-error-codes.yml
        decline_codes: errors/payjp-decline-codes.yml
        webhooks: asyncapi/payjp-webhooks.yml
        sandbox: sandbox/payjp-sandbox.yml
        lifecycle: lifecycle/payjp-lifecycle.yml
        changelog: changelog/payjp-changelog.yml
        components: components/payjp-components.yml
        data_model: data-model/payjp-data-model.yml
        conformance: conformance/payjp-conformance.yml
        packages: packages/payjp-packages.yml
  - target: $.info
    update:
      x-payjp-currency: JPY
      x-payjp-auth: HTTP Basic (secret key as username, empty password)
      x-payjp-idempotency: not-supported
      x-payjp-pagination: offset (limit/offset/since/until)
  - target: $.components.securitySchemes.basicAuth
    update:
      x-key-prefixes: [sk_test_, sk_live_]
      x-client-side-key: publishable key (pk_test_ / pk_live_) via payjp.js / Checkout

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/payjp-openapi-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.