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

Payplug (BYOK) — connector documentation

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

What Payplug (BYOK) is for

Payplug (BYOK) lets an AI assistant read your own Payplug data through the Payplug API with a key you supply (secret API key (sk_live_... or sk_test_...)). Read-only: 6 tools (list_payments, get_payment, list_payment_refunds, get_refund, get_installment_plan, get_accounting_report). 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.payplug.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Payplug. Payplug 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:

  • "What payments did my shop receive through Payplug recently?"
  • "Was Payplug payment pay_5iHMDxy4ABR4YBVW4UscIn paid and refunded?"
  • "What refunds were made on Payplug payment pay_5iHMDxy4ABR4YBVW4UscIn?"
  • "Show Payplug refund re_3NxGqPfSGMHQgLSZH0Mv3B"
  • "Is Payplug installment plan inst_2JhnPxy4ABR4YBVW4UscWx fully paid?"
  • "Is accounting report ar_6zrx929ldfIzqnX6KktHzZ ready to download?"

What it does

  • list_payments: List payments created through the Payplug API (payments made in the Payplug portal are not listed), newest first, with amount in cents, currency and paid and refunded flags.
  • get_payment: Get one payment by id: amount in cents, refunded amount, currency, paid time, 3-D Secure flag, card brand and country, billing country.
  • list_payment_refunds: List the refunds made against one payment, with amount in cents, currency and creation time.
  • get_refund: Get one refund of a payment by refund id: amount in cents, currency and creation time.
  • get_installment_plan: Get an installment plan by id: whether it is active and fully paid, currency and the schedule of dates and amounts in cents.
  • get_accounting_report: Get a previously generated accounting report by id: date range and, once ready, a temporary download link valid for 24 hours. Reports cannot be created with this connector.

BYOK key

You bring your own Payplug secret API key (sk_live_... or sk_test_...) (https://portal.payplug.com/). 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.payplug.com 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 Payplug API (api.payplug.com) with a BYOK key; documentation: https://docs.payplug.com/api/apiref.html. 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 Payplug. Payplug 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 Payplug account.

Built for: Worldwide. Languages: English.