mcp server
PayRam Helper MCP Server
Remote MCP server to integrate and validate self-hosted PayRam deployments.
Description as published by the maintainer. Source
- version 1.1.0
- slowing
slowing — Registry entry last updated 2026-02-17.
What this server can do
52 functions, named and described by the server itself. Parameter names are shown because they say more about what a function does than its name usually does.
assess_payram_project- Inspects dependency files, frameworks, and .env status to suggest the next integration actions.
check_node_sync- Per-chain node health verdict: healthy / lagging / unreachable / listener-down. Computes how old each RPC node’s last block is — any non-BTC chain older than 10 minutes (BTC: 90 minutes, since BTC blocks every ~10m) is flagged as lagging or not syncing. Also checks the chain’s listener worker. When something is wrong it names the exact remediation (usually restart_payram_worker). Read-only — run this first; restart second; re-run this ~60s after a restart to confirm recovery.
check_payment_readiness(externalPlatformId)- Diagnoses what is NOT yet set up to accept payments, per blockchain: missing deposit wallet, chain/currency not enabled for the project, or a stopped listener worker. Read-only — reports gaps and points to the CLI for wallet setup; it does not create wallets itself.
create_payment_link(customerID, amountInUSD, customerEmail)- Creates a PayRam checkout (payment) link and returns the hosted URL plus a reference_id. Authenticates with the Merchant API-Key (set PAYRAM_API_KEY). This WRITES — it creates a real payment request. The customer chooses the chain/currency on the hosted checkout. Poll status later with lookup_payment (or GET /api/v1/payment/reference/{reference_id}). Required: amountInUSD, customerID, customerEmail.
explain_payment_flow- Describe how payments move from customer initiation through settlement.
explain_payram_basics- Explain Payram's product pillars, architecture, payments, and payouts capabilities.
explain_payram_concepts- Glossary-backed explanation of Payram terminology and constraints.
explain_referral_flow- Detail the referrer/referee lifecycle and required APIs.
explain_referrals_basics- Summarize how Payram referral campaigns are configured and managed.
generate_env_template- Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server.
generate_mock_webhook_event(status, language)- Generates a snippet to send mock Payram webhook events to your local endpoint for testing. Required: language, status.
generate_payment_http_snippet(language)- Generates a raw HTTP sample for creating a Payram payment in the requested language. Required: language.
generate_payment_route_snippet(framework)- Generates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment. Required: framework.
generate_payment_sdk_snippet(framework)- Generates backend code using the official Payram JS/TS SDK to create a payment. Required: framework.
generate_payment_status_snippet(style)- Generates backend code to query the status of a Payram payment. Required: style.
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_payout_sdk_snippet(framework)- Generates a backend code snippet for creating a payout using the Payram JS/TS SDK. Required: framework.
generate_payout_status_snippet- Generates backend code to query the status of a payout using the Payram SDK.
generate_referral_route_snippet(framework)- Generates a backend route such as /api/referrals/create for logging referral events. Required: framework.
generate_referral_sdk_snippet(framework)- Generates a backend route or service snippet to create a referral event using the Payram SDK. Required: framework.
generate_referral_status_snippet(style)- Generates code to fetch referral progress, rewards, or status. Required: style.
generate_referral_validation_snippet- Generates a snippet to validate referral IDs, statuses, and eligibility.
generate_setup_checklist- Returns a step-by-step checklist of everything a merchant must configure to start using Payram.
generate_topup_integration_snippet(part, framework)- 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.)
generate_webhook_event_router- Generates a backend event router that dispatches Payram webhook events to domain handlers.
generate_webhook_handler(framework)- Generates backend code to handle Payram webhook HTTP requests. Required: framework.
get_agent_setup_flow- Returns the step-by-step setup flow for deploying PayRam as an agent. Covers install, wallet creation, faucet funding, contract deployment, and first payment. Includes chain recommendations (ETH Sepolia for testnet, Base for mainnet), faucet URLs, card-to-crypto prerequisites, and status/recovery commands for interrupted sessions.
get_daily_volume(date, externalPlatformId)- Returns the total payment volume for a given date, with breakdowns by network and currency. Only counts FILLED (completed) payments. Defaults to today if no date is specified.
get_payment_summary(externalPlatformId)- Returns payment counts: total, open, closed, and cancelled. Useful for a quick overview of payment activity.
get_payram_doc_by_id(id)- Returns the markdown for a Payram doc given its id, e.g. "features/payouts". Required: id.
get_payram_links- Surface official documentation, website, and community links.
get_referral_dashboard_guide- Explain how to embed and manage the referral dashboard experience.
get_unswept_balances- Returns unswept (unsettled) balances across all wallets, broken down by blockchain and currency. Shows sweep readiness per entry (sweep, sweep_in_progress, sweep_not_allowed, no_balance) AND why stuck funds are stuck: lastSweepError (e.g. HOT_WALLET_LOW_GAS with the hot-wallet address to fund), pending SCW deployment, or missing cold wallet. Use this to answer "where is my money / why has it not swept".
list_currencies- Lists every blockchain currency PayRam supports on this node (chain code, network, currency code). Public endpoint — works with only PAYRAM_BASE_URL set, no API key or JWT required. Use this to discover valid blockchainCode/currencyCode values before creating payments or payouts.
list_payram_docs(prefix)- Lists the available Payram doc ids relative to docs/payram-docs-live. Optionally scope by a prefix such as "features".
list_platforms- Lists all external platforms (projects) for the authenticated user. Use this to discover your platform ID, which other tools auto-resolve if omitted.
list_recipients- Lists saved withdrawal recipients (payout beneficiaries). Use this to find a recipient ID for the 3-step payout flow, or to check whether a beneficiary is already OTP-verified (status "active") before creating a payout.
lookup_payment(query, externalPlatformId)- Look up payments by transaction hash, email, reference ID, customer ID, or invoice ID. Returns up to 5 matching payments with full details. Required: query.
onboard_agent_setup- Returns the complete autonomous agent setup guide for deploying Payram without any web UI or human interaction.
payram_doctor(apiKey, baseUrl)- Staged, read-only health diagnosis: server reachability -> merchant API key -> admin JWT -> payment readiness (wallets + listener workers). Returns ranked likely causes with exact fix commands for the first failing stage. Run this FIRST when anything PayRam-related fails.
prepare_payram_test- Confirm hosting, credentials, and environment variables before generating demo apps.
restart_payram_worker(all, worker)- REMEDIATION ACTION (write): restarts a blockchain listener worker via supervisor — the minimal fix when check_node_sync reports a chain as lagging or listener-down. Workflow: run check_node_sync first → restart the named worker → wait ~60s → run check_node_sync again to confirm recovery. A restart does NOT fix an unreachable RPC (fix the RPC config in the dashboard instead). Requires admin JWT with write_system_settings.
scaffold_payram_app(appName, language, framework, includeWebhooks)- Generates a minimal full-stack app skeleton with Payram payments and payouts routes (and a simple UI) for a chosen language and framework. Required: language, framework.
search_payments(limit, query, dateTo, offset, sortBy, network, currency, dateFrom, createdBy, paymentStatus, sortDirection, webhookStatus, externalPlatformId)- Search and filter payments with full control over status, network, currency, dates, webhook status, and pagination. Returns a paginated list of matching payments.
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_go_payment_handler- Returns a Gin handler that proxies /api/pay/create to Payram's create-payment API.
snippet_laravel_payment_route- Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint.
snippet_nextjs_payment_route- Returns a Next.js App Router API route that calls Payram's create-payment HTTP API.
snippet_spring_payment_controller- Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint.
suggest_file_structure- Suggests a recommended backend folder/file structure for integrating Payram.
test_payram_connection(apiKey, baseUrl)- Checks the /api/v1/payment endpoint on a Payram server using baseUrl and apiKey. If they are not provided, returns a .env template you can add to your workspace.
Last successful function declaration observed on . Source: https://mcp.payram.com/. We list what the server declared; we do not call any of these functions.
Endpoint status observed on . Source: https://mcp.payram.com/.
Signals
These are separate measurements of different things. They are deliberately not combined into one score, because a popularity number that mixes website traffic with saves and stars cannot be checked or acted on.
| Signal | Value | What it measures | Window | Observed | Source |
|---|---|---|---|---|---|
| Latest published version | 1.1.0 | Latest version string the maintainer published to the registry. | as of fetch | Model Context Protocol | |
| Registry record last updated | 2026-02-17 | When the registry record was last updated by its maintainer. | point in time | Model Context Protocol | |
| First listed in the MCP Registry | 2026-02-17 | Date this server was first published to the official MCP Registry. Not a usage or quality measure. | point in time | Model Context Protocol | |
| mcp tools declared | 52 tools | Number of functions the server itself declared when asked to list them. This is what the server offers an agent, not a measure of how well any of them work. | as of probe | mcp.payram.com | |
| mcp endpoint status | ok | The server listed 52 functions when asked. | as of probe | mcp.payram.com |
Where to get it
This record as data
Every field on this page, with its source and observation date, is in the catalog JSON. Fetch the whole kind at once instead of parsing this HTML.
GET /api/v1/entries/mcp_server.json