PAY.JP

PAY.JP Transfers API

The Transfers API from PAY.JP — 3 operation(s) for transfers.

GitHub OpenAPI

Operations 3

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 /transfers List payouts · List transfers (入金) #
Ask an LLM
“When have I been paid out to my bank account?”
“How do I see all my deposits?”
Tell an agent
List my payouts.
Show every transfer to my bank account.
GET /transfers/{id} Get a payout · Retrieve a transfer #
Ask an LLM
“How do I look up one payout's amount and date?”
“What's the status of a particular transfer?”
Tell an agent
Show transfer {id}.
Get the details of payout {id}.
GET /transfers/{id}/details List the charges in a payout · List the charges settled in a transfer #
Ask an LLM
“Which charges were settled in a specific payout?”
“Can I break a transfer down into its individual charges?”
Tell an agent
List the charges settled in transfer {id}.
Break payout {id} down into its charges.

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-transfers-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-transfers-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-transfers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PAY.JP Transfers 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: Transfers
paths:
  /transfers:
    get:
      operationId: listTransfers
      tags:
      - Transfers
      summary: List transfers (入金)
      responses:
        '200':
          $ref: '#/components/responses/List'
  /transfers/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: retrieveTransfer
      tags:
      - Transfers
      summary: Retrieve a transfer
      responses:
        '200':
          $ref: '#/components/responses/Object'
  /transfers/{id}/details:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: listTransferDetails
      tags:
      - Transfers
      summary: List the charges settled in a transfer
      responses:
        '200':
          $ref: '#/components/responses/List'
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.