PayRam

The 44 tools it listed

"Read only" and "Changes data" are the server's own marks. Underlined parameters are required.

1. explain_payment_flowRead only

   Payment Flow Guide

   Describe how payments move from customer initiation through settlement.

2. explain_payram_basicsRead only

   Payram Basics Overview

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

3. explain_payram_conceptsRead only

   Core Payram Concepts

   Glossary-backed explanation of Payram terminology and constraints.

4. explain_payram_securityRead only

   Is PayRam safe? Security and trust

   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.

5. explain_referral_flowRead only

   Referral Flow Guide

   Detail the referrer/referee lifecycle and required APIs.

6. explain_referrals_basicsRead only

   Referral Basics Overview

   Summarize how Payram referral campaigns are configured and managed.

7. generate_env_templateRead only

   Generate Payram .env Template

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

8. generate_mock_webhook_eventRead only

   Generate mock Payram webhook event

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

   language status

9. generate_payment_http_snippetRead only

   Generate HTTP payment snippet

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

   language

10. generate_payment_route_snippetRead only

    Generate payment route snippet

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

    framework

11. generate_payment_sdk_snippetRead only

    Generate SDK payment snippet

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

    framework

12. generate_payment_status_snippetRead only

    Generate payment status snippet

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

    style

13. generate_payout_recipient_flow_snippetRead only

    Generate 3-step recipient payout 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.

14. generate_payout_sdk_snippetRead only

    Generate payout SDK snippet

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

    framework

15. generate_payout_status_snippetRead only

    Generate payout status SDK snippet

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

16. generate_referral_route_snippetRead only

    Generate referral route snippet

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

    framework

17. generate_referral_sdk_snippetRead only

    Generate referral SDK snippet

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

    framework

18. generate_referral_status_snippetRead only

    Generate referral status snippet

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

    style

19. generate_referral_validation_snippetRead only

    Generate referral validation snippet

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

20. generate_setup_checklistRead only

    Generate Payram Setup Checklist

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

21. generate_topup_integration_snippetRead only

    Generate top-up wallet integration

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

    part framework

22. generate_webhook_event_routerRead only

    Generate Payram webhook event router

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

23. generate_webhook_handlerRead only

    Generate Payram webhook HTTP handler

    Generates backend code to handle Payram webhook HTTP requests.

    framework

24. get_agent_setup_flowRead only

    Get the headless agent guide (full reference)

    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.

25. get_payram_doc_by_idRead only

    Get Payram Doc By ID

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

    id

26. get_payram_linksRead only

    Payram Important Links

    Surface official documentation, website, and community links.

27. get_referral_dashboard_guideRead only

    Referral Dashboard Guide

    Explain how to embed and manage the referral dashboard experience.

28. list_payram_docsRead only

    List Payram Docs

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

    prefix

29. onboard_agent_setupRead only

    Onboard: install PayRam as an agent (deprecated)

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

30. payram_doctorRead only

    Diagnose a PayRam server

    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.

    baseUrl apiKey

31. payram_ops_playbookRead only

    PayRam ops playbook (direct API recipes)

    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.

    task

32. payram_runbookRead only

    PayRam runbooks (one-off admin tasks)

    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.

    task

33. payram_setup_planRead only

    Plan a PayRam install (step by step)

    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.

    path network domain ssl role wallet stage access integration

34. payram_troubleshootRead only

    Troubleshoot a PayRam problem

    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.

    symptom output area id

35. prepare_payram_testRead only

    Payram Test Readiness Checklist

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

36. scaffold_payram_appRead only

    Scaffold Payram Payments & Payouts App

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

    language framework appName includeWebhooks

37. snippet_express_payment_routeRead only

    Express create-payment route snippet

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

38. snippet_fastapi_payment_routeRead only

    FastAPI create-payment route snippet

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

39. snippet_go_payment_handlerRead only

    Go (Gin) create-payment route snippet

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

40. snippet_laravel_payment_routeRead only

    Laravel create-payment route snippet

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

41. snippet_nextjs_payment_routeRead only

    Next.js create-payment route snippet

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

42. snippet_spring_payment_controllerRead only

    Spring Boot create-payment controller snippet

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

43. suggest_file_structureRead only

    Suggest Payram File Structure

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

44. test_payram_connectionRead only

    Test PayRam connectivity (deprecated)

    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.

    baseUrl apiKey