PAY.JP

PAY.JP Platform API

The Platform API from PAY.JP — 4 operation(s) for platform.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /tenants List platform tenants · List platform tenants (beta) #
Ask an LLM
“Which sub-merchants are registered under my platform?”
“How do I see all my platform tenants?”
Tell an agent
List my platform tenants.
Show every sub-merchant on my platform.
POST /tenants Add a sub-merchant tenant · Create a platform tenant (sub-merchant) #
Ask an LLM
“How do I onboard a new sub-merchant onto my platform?”
“Can I create tenants through the API while the platform feature is in beta?”
Tell an agent
Create a new platform tenant.
Register a new sub-merchant on my platform.
GET /tenants/{id} Get a platform tenant · Retrieve a tenant #
Ask an LLM
“How do I look up one sub-merchant's tenant record?”
“What details are stored for a particular tenant?”
Tell an agent
Show tenant {id}.
Get the details of sub-merchant tenant {id}.
POST /tenants/{id} Update a platform tenant · Update a tenant #
Ask an LLM
“How do I change a sub-merchant's tenant details?”
“Can I edit a tenant after onboarding them?”
Tell an agent
Update tenant {id}.
Edit sub-merchant tenant {id}.
DELETE /tenants/{id} Remove a platform tenant · Delete a tenant #
Ask an LLM
“How do I remove a sub-merchant from my platform?”
“What happens when I delete a tenant?”
Tell an agent destructive · confirm first
Delete tenant {id}.
Remove sub-merchant tenant {id} from my platform.
GET /tenant_transfers List payouts to tenants · List tenant transfers #
Ask an LLM
“How do I see the payouts made to my sub-merchants?”
“Which tenant transfers has my platform generated?”
Tell an agent
List my tenant transfers.
Show every payout to platform tenants.
GET /tenant_transfers/{id} Get a tenant transfer · Retrieve a tenant transfer #
Ask an LLM
“How do I check the details of one payout to a sub-merchant?”
“What went into a specific tenant transfer?”
Tell an agent
Show tenant transfer {id}.
Get the details of sub-merchant payout {id}.

Documentation

📖
Documentation
https://pay.jp/docs/charge
📖
APIReference
https://docs.pay.jp/v1/api/
📖
Documentation
https://docs.pay.jp/v1/customer
📖
Documentation
https://docs.pay.jp/v1/subscription
📖
Documentation
https://pay.jp/docs/platform-payment

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/payjp/refs/heads/main/openapi/payjp-platform-api-openapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/payjp:payjp-platform-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

payjp-platform-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PAY.JP Platform API
  description: PAY.JP is an online payment service operated by PAY, Inc. (PAY株式会社) in Japan. The REST API creates charges, tokenizes cards, manages customers, runs subscriptions (定期課金), and reports transfers (入金) and balances in Japanese yen. Authentication is HTTP Basic with a secret key (sk_test_ / sk_live_) as the username and an empty password. All amounts are integer JPY.
  termsOfService: https://pay.jp/terms
  contact:
    name: PAY.JP Support
    url: https://help.pay.jp/
  version: '1.0'
servers:
- url: https://api.pay.jp/v1
  description: PAY.JP REST API (HTTPS only)
security:
- basicAuth: []
tags:
- name: Platform
paths:
  /tenants:
    get:
      operationId: listTenants
      tags:
      - Platform
      summary: List platform tenants (beta)
      responses:
        '200':
          $ref: '#/components/responses/List'
    post:
      operationId: createTenant
      tags:
      - Platform
      summary: Create a platform tenant (sub-merchant)
      responses:
        '200':
          $ref: '#/components/responses/Object'
  /tenants/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: retrieveTenant
      tags:
      - Platform
      summary: Retrieve a tenant
      responses:
        '200':
          $ref: '#/components/responses/Object'
    post:
      operationId: updateTenant
      tags:
      - Platform
      summary: Update a tenant
      responses:
        '200':
          $ref: '#/components/responses/Object'
    delete:
      operationId: deleteTenant
      tags:
      - Platform
      summary: Delete a tenant
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
  /tenant_transfers:
    get:
      operationId: listTenantTransfers
      tags:
      - Platform
      summary: List tenant transfers
      responses:
        '200':
          $ref: '#/components/responses/List'
  /tenant_transfers/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: retrieveTenantTransfer
      tags:
      - Platform
      summary: Retrieve a tenant transfer
      responses:
        '200':
          $ref: '#/components/responses/Object'
components:
  schemas:
    List:
      type: object
      properties:
        object:
          type: string
          example: list
        count:
          type: integer
        has_more:
          type: boolean
        url:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Object'
    Object:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        livemode:
          type: boolean
        created:
          type: integer
          description: Unix timestamp
      additionalProperties: true
  responses:
    Deleted:
      description: A deletion confirmation
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
              object:
                type: string
                example: charge
              deleted:
                type: boolean
                example: true
    List:
      description: A paginated list object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/List'
    Object:
      description: A PAY.JP resource object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Object'
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication. Use the secret key (sk_test_ / sk_live_) as the username and leave the password empty.