PAY.JP

PAY.JP Balances API

The Balances API from PAY.JP — 2 operation(s) for balances.

GitHub OpenAPI

Operations 2

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 /balances List account balances · List account balances (残高) #
Ask an LLM
“What balances do I have accumulating on my account?”
“Can I see a list of all my balance records?”
Tell an agent
List my account balances.
Show every balance on my account.
GET /balances/{id} Get a single balance · Retrieve a balance #
Ask an LLM
“How do I look up the details of one specific balance?”
“What's in a particular balance record?”
Tell an agent
Show balance {id}.
Get the details of balance {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-balances-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-balances-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-balances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PAY.JP Balances 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: Balances
paths:
  /balances:
    get:
      operationId: listBalances
      tags:
      - Balances
      summary: List account balances (残高)
      responses:
        '200':
          $ref: '#/components/responses/List'
  /balances/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: retrieveBalance
      tags:
      - Balances
      summary: Retrieve a balance
      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
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
  responses:
    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'
  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.