PayRam

Reviewed 1d ago.

• tools: 42 tools scanned
• metadata: scanned

No findings.

Tools (42)

• payram_setup_plan

  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). Pass stage to resume mid-way.

• payram_doctor

  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.

• payram_runbook

  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. Omit task to list them.

• payram_ops_playbook

  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.

• test_payram_connection

  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. For a full diagnosis use payram_doctor.

• generate_env_template

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

• generate_setup_checklist

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

• suggest_file_structure

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

• get_agent_setup_flow

  Returns the canonical PayRam headless-agent guide (payram-scripts PAYRAM_HEADLESS_AGENT.md): 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.

• onboard_agent_setup

  Quick start for an agent installing PayRam on a VPS: returns the default headless plan (testnet, USDC on Base) with exact commands and the human hand-offs. Same as payram_setup_plan with defaults; call that tool to personalise (domain, mainnet, BTC, operator, Shopify/WooCommerce).

• generate_payment_sdk_snippet

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

• generate_payment_http_snippet

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

• generate_payment_status_snippet

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

• generate_payment_route_snippet

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

• snippet_nextjs_payment_route

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

• snippet_express_payment_route

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

• snippet_fastapi_payment_route

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

• snippet_laravel_payment_route

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

• snippet_go_payment_handler

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

• snippet_spring_payment_controller

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

• generate_payout_sdk_snippet

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

• generate_payout_status_snippet

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

• generate_payout_recipient_flow_snippet

  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.

• generate_referral_sdk_snippet

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

• generate_referral_validation_snippet

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

• generate_referral_status_snippet

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

• generate_referral_route_snippet

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

• generate_webhook_handler

  Generates backend code to handle Payram webhook HTTP requests.

• generate_webhook_event_router

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

• generate_mock_webhook_event

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

• generate_topup_integration_snippet

  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.)

• explain_payram_basics

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

• get_payram_links

  Surface official documentation, website, and community links.

• explain_payment_flow

  Describe how payments move from customer initiation through settlement.

• explain_payram_concepts

  Glossary-backed explanation of Payram terminology and constraints.

• explain_referrals_basics

  Summarize how Payram referral campaigns are configured and managed.

• explain_referral_flow

  Detail the referrer/referee lifecycle and required APIs.

• get_referral_dashboard_guide

  Explain how to embed and manage the referral dashboard experience.

• prepare_payram_test

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

• get_payram_doc_by_id

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

• list_payram_docs

  Lists the available Payram doc ids relative to docs/payram-docs-live. Optionally scope by a prefix such as "features".

• scaffold_payram_app

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