PayRam

Measured conclusion: Alive, not deep-tested. L2 outcome: not_attempted.

Install, configure, operate and integrate self-hosted PayRam crypto payment gateways.

Add to your agent

Copy this into your MCP client config:

{
  "mcpServers": {
    "PayRam": {
      "url": "https://mcp.payram.com/mcp",
      "transport": "streamable-http"
    }
  }
}

Measured tools (44)

• payram_setup_plan read-only

  Start here to install PayRam on a VPS. Returns an ordered, personalised plan — prepare server → install → claim admin + set public URL → wallets (incl. Smart Bridge review) → API key + first payment link → hardening → store/app integration — with who runs each step (agent shell vs human/dashboard), exact commands, what success looks like, and hard stops that need the human (cold wallet, mainnet spend, root-only settings). Ask the user first whether you can run commands on their server (access "ssh") or only chat with them (access "human_runs_commands": they run each command and paste the output back). Pass stage to resume mid-way; payram_doctor tells you the stage of a running server.

  Parameters:

  • ssl — string — letsencrypt (needs domain), own_certificate, proxy (Cloudflare/your own reverse proxy terminates TLS), none. Default: letsencrypt with a domain, none without.
  • path — string — agent = headless CLI after a one-time interactive install; human = installer + web dashboard
  • role — string — merchant: Take payments for your own business (default). operator: Run PayRam as a platform for other merchants and earn a fee on their volume. Must be chosen before the first project; the role locks once role-specific data exists.
  • stage — string — Where you are now; the plan starts from the next step
  • access — string — ssh = you can run commands on the server yourself. human_runs_commands = you only chat: the human runs each command and pastes the output back. Ask the user which applies before planning.
  • domain — string — Public hostname for the gateway, e.g. pay.example.com. Omit if you only have an IP for now.
  • wallet — string — First deposit wallet: usdc_base (smart-contract wallet on Base, needs a little gas), btc (xpub, no gas), or both
  • network — string — testnet = free test coins (recommended first); mainnet = real money
  • integration — string — What will take payments once the gateway is up

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• payram_doctor read-only

  Read-only diagnosis of a PayRam server by its public URL — works from the hosted MCP without credentials: reachability, health, TLS certificate, installed vs latest version, worker states. Optionally validates an API key without creating anything. Returns ranked likely causes and exact fixes for the first failing stage. Run this first when anything PayRam-related fails.

  Parameters:

  • apiKey — string — Optional project API key to validate (never creates anything). Passing it puts the key in this conversation; prefer running payram_ops_playbook "connect" locally.
  • baseUrl — string — Public address of the PayRam server, same origin as the dashboard: https://pay.example.com, or just pay.example.com or an IP (https is tried first, then http). No :8080, no path. Required on the hosted MCP.

  Hints: read-only yes · destructive no · idempotent yes · open-world yes

• payram_troubleshoot read-only

  Something is not working? Describe the problem in plain words and/or paste the error or log text. Returns the known PayRam problems it matches, what each usually means, how to confirm it and the fix, plus which tool to use next. Needs no credentials and no access to the server; what you paste is not stored. Call with nothing to list known problems. For a live check of a running server use payram_doctor.

  Parameters:

  • id — string — Show one known problem by its id (from an earlier answer).
  • area — string — Narrow the search to one area.
  • output — string — Error text or log lines to match. Remove API keys, tokens, passwords and seed phrases first.
  • symptom — string — The problem in plain words, e.g. "payment link opens localhost" or "502 after upgrade".

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• payram_runbook read-only

  Step-by-step procedures for changes to a running PayRam, each step marked agent vs human with hard stops: set_site_url, change_domain, ssl_setup, ssl_renewal_fix, firewall_ports, upgrade, backup, restore, add_chain, smart_bridge, mainnet_cutover, operator_setup, rotate_api_key, reset_test_install, shopify_connector, woocommerce_plugin, secure_analytics_mcp, install_failed, custom_port_or_proxy, external_database, forgot_root_password. Omit task to list them.

  Parameters:

  • task — string — Which runbook. Omit to list all.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• payram_ops_playbook read-only

  Exact, copy-paste recipes for day-2 operations and troubleshooting that YOU run against the merchant's PayRam API with credentials that stay on your machine: which endpoint, which credential (public / dashboard JWT / project API key), a curl+jq command, how to read the answer, and what not to do. Start with "connect". Tasks: connect, health, version_check, workers, restart_worker, node_sync, site_url, payment_options, unswept_funds, payments_today, payment_lookup, stuck_payment, create_payment_link, payouts, webhooks, logs, daily_check. Omit task to list them.

  Parameters:

  • task — string — Which recipe. Omit to get the index of tasks.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_env_template read-only

  Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_setup_checklist read-only

  Returns a step-by-step checklist of everything a merchant must configure to start using Payram.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• suggest_file_structure read-only

  Suggests a recommended backend folder/file structure for integrating Payram.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• get_agent_setup_flow read-only

  Returns the canonical PayRam headless-agent guide: agent CLI commands, env vars, merchant vs operator mode, wallet flows, adding chains, troubleshooting. Long (~11k tokens). For a short personalised plan use payram_setup_plan.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_payment_sdk_snippet read-only

  Generates backend code using the official Payram JS/TS SDK to create a payment.

  Parameters:

  • framework (required) — string — Target framework for the SDK payment snippet. generic-http provides a framework-agnostic example.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_payment_http_snippet read-only

  Generates a raw HTTP sample for creating a Payram payment in the requested language.

  Parameters:

  • language (required) — string — Programming language for the HTTP payment creation snippet

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_payment_status_snippet read-only

  Generates backend code to query the status of a Payram payment.

  Parameters:

  • style (required) — string — Style of code snippet: sdk uses the Payram SDK, http uses raw HTTP requests

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_payment_route_snippet read-only

  Generates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment.

  Parameters:

  • framework (required) — string — Web framework for the payment route handler (Express.js or Next.js)

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• snippet_nextjs_payment_route read-only

  Returns a Next.js App Router API route that calls Payram's create-payment HTTP API.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• snippet_express_payment_route read-only

  Returns an Express router that posts to Payram's /api/v1/payment endpoint.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• snippet_fastapi_payment_route read-only

  Returns a FastAPI handler that calls Payram's create-payment HTTP API.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• snippet_laravel_payment_route read-only

  Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• snippet_go_payment_handler read-only

  Returns a Gin handler that proxies /api/pay/create to Payram's create-payment API.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• snippet_spring_payment_controller read-only

  Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_payout_sdk_snippet read-only

  Generates a backend code snippet for creating a payout using the Payram JS/TS SDK.

  Parameters:

  • framework (required) — string — Target framework for the payout SDK snippet

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_payout_status_snippet read-only

  Generates backend code to query the status of a payout using the Payram SDK.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_payout_recipient_flow_snippet read-only

  Generates the recommended OTP-verified payout flow: create recipient → validate OTP → create payout against the saved recipient. Use this for repeat beneficiaries; use generate_payout_sdk_snippet for one-off direct payouts.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_referral_sdk_snippet read-only

  Generates a backend route or service snippet to create a referral event using the Payram SDK.

  Parameters:

  • framework (required) — string — Target framework for the referral SDK snippet

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_referral_validation_snippet read-only

  Generates a snippet to validate referral IDs, statuses, and eligibility.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_referral_status_snippet read-only

  Generates code to fetch referral progress, rewards, or status.

  Parameters:

  • style (required) — string — Style of code snippet: sdk uses the Payram SDK, backend-only shows direct API calls

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_referral_route_snippet read-only

  Generates a backend route such as /api/referrals/create for logging referral events.

  Parameters:

  • framework (required) — string — Web framework for the referral route handler (Express.js or Next.js)

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_webhook_handler read-only

  Generates backend code to handle Payram webhook HTTP requests.

  Parameters:

  • framework (required) — string — Web framework for the webhook handler code

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_webhook_event_router read-only

  Generates a backend event router that dispatches Payram webhook events to domain handlers.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_mock_webhook_event read-only

  Generates a snippet to send mock Payram webhook events to your local endpoint for testing.

  Parameters:

  • language (required) — string — Language/tool for the mock webhook request (curl for command-line testing)
  • status (required) — string — Payment status to simulate in the mock webhook event

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• generate_topup_integration_snippet read-only

  For EXISTING apps: emits the recommended top-up wallet integration — ledger schema + cumulative-credit webhook handler + atomic invoice-settle function. Credits crypto payments to a user's balance first, then debits invoices from it, so over/under/late/duplicate payments become balance states, not payment exceptions. Pair with the payram-topup-wallet-integration skill. (New store with no users? Use the checkout/plugin path instead.)

  Parameters:

  • part — string — Which piece to emit: 'schema' (ledger DDL), 'webhook' (cumulative-credit handler), 'settle' (atomic invoice debit), or 'all'.
  • framework — string — Server framework for the webhook handler + settle function.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• explain_payram_basics read-only

  Explain Payram's product pillars, architecture, payments, and payouts capabilities.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• explain_payram_security read-only

  Answer "is PayRam safe / trustworthy / audited?": why an agent can use it without holding secrets, the independent smart contract audit (what it covers and what it does not), and how to verify the report.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• get_payram_links read-only

  Surface official documentation, website, and community links.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• explain_payment_flow read-only

  Describe how payments move from customer initiation through settlement.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• explain_payram_concepts read-only

  Glossary-backed explanation of Payram terminology and constraints.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• explain_referrals_basics read-only

  Summarize how Payram referral campaigns are configured and managed.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• explain_referral_flow read-only

  Detail the referrer/referee lifecycle and required APIs.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• get_referral_dashboard_guide read-only

  Explain how to embed and manage the referral dashboard experience.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• prepare_payram_test read-only

  Confirm hosting, credentials, and environment variables before generating demo apps.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• get_payram_doc_by_id read-only

  Returns the markdown for a Payram doc given its id, e.g. "features/payouts".

  Parameters:

  • id (required) — string

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• list_payram_docs read-only

  Lists the available Payram doc ids. Optionally scope by a prefix such as "features".

  Parameters:

  • prefix — string

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• scaffold_payram_app read-only

  Generates a minimal full-stack app skeleton with Payram payments and payouts routes (and a simple UI) for a chosen language and framework.

  Parameters:

  • language (required) — string — Programming language for the application (node for JavaScript/TypeScript)
  • framework (required) — string — Web framework to use for scaffolding the application
  • appName — string — Name for the generated application. If not provided, defaults to payram-{framework}-starter
  • includeWebhooks — boolean — Whether to include webhook handler code in the scaffolded application

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• test_payram_connection read-only

  Deprecated: use payram_doctor, which does this and more. Read-only check that a PayRam server is reachable and healthy and, if an API key is supplied, that the key is accepted. Never creates payments.

  Parameters:

  • apiKey — string — Optional project API key to validate (nothing is created). Passing it exposes the key in this conversation.
  • baseUrl — string — PayRam URL, same origin as the dashboard (e.g. https://pay.example.com). Defaults to PAYRAM_BASE_URL in local mode.

  Hints: read-only yes · destructive no · idempotent yes · open-world yes

• onboard_agent_setup read-only

  Deprecated: use payram_setup_plan, which does this and lets you personalise it. Returns the default headless plan (testnet, USDC on Base).

  Hints: read-only yes · destructive no · idempotent yes · open-world no

Publisher website Repository

Measured by MCPYP probing. Untested fields are omitted, never estimated. Listing is always free; MCPYP never proxies calls or stores user tokens.