Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

PAY.JP (BYOK) — connector documentation

  • MCP endpoint: https://byok-payjp.connectorbay.com/mcp
  • REST API: POST https://byok-payjp.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-payjp.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own PAY.JP secret key (sk_live_... or sk_test_...), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-payjp.connectorbay.com/health · Tool schemas: https://byok-payjp.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-payjp · agent@connectorbay.com

What PAY.JP (BYOK) is for

PAY.JP (BYOK) lets an AI assistant read your own PAY.JP data through the PAY.JP API with a key you supply (secret key (sk_live_... or sk_test_...)). Read-only: 9 tools (get_account, list_charges, get_charge, list_customers, list_plans, list_subscriptions, get_subscription, list_balances, list_events). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.pay.jp. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by PAY.JP. PAY.JP and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which PAY.JP account is this key for?"
  • "What PAY.JP payments came in during October 2026?"
  • "What happened to PAY.JP payment ch_cce2fce62e9cb5632b3d38b0b1621?"
  • "Which PAY.JP customers were created recently?"
  • "Which subscription plans exist in PAY.JP?"
  • "Which PAY.JP subscriptions are active?"

What it does

  • get_account: Show the PAY.JP account the key belongs to: account id, team id, country, default currency, accepted card brands and live-mode status.
  • list_charges: List payments newest first with amount, currency, paid and captured flags, refunds, failure reason, customer and card brand; filter by customer, subscription and creation time. Card numbers are not returned by this tool.
  • get_charge: Get one payment by id with amount, status flags, refunds, failure reason, customer, subscription and card brand and country.
  • list_customers: List customers newest first with id, description, default card id and creation time (email addresses are not returned by this tool).
  • list_plans: List recurring-payment plans with amount, currency, interval, billing day and trial days.
  • list_subscriptions: List subscriptions newest first with status, plan, customer, billing period and cancel or pause times; filter by plan, customer and status.
  • get_subscription: Get one subscription by id with status, plan, customer, billing period and cancel or pause times.
  • list_balances: List balances (settlement units) with state, net amount, due date and closed flag; filter by state, closed flag and due date.
  • list_events: List account events (charge, subscription, customer and other changes) newest first with type and time; filter by event type, resource type and resource id.

BYOK key

You bring your own PAY.JP secret key (sk_live_... or sk_test_...) (https://pay.jp/d/settings). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.pay.jp over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the PAY.JP API (api.pay.jp) with a BYOK key; documentation: https://pay.jp/docs/api/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by PAY.JP. PAY.JP and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your PAY.JP account.

Built for: Worldwide. Languages: English.