Back to search
100
MCP live v1.0.0 MCP 2025-11-25 http

PayRam Helper MCP Server

io.github.payram/payram-helper-mcp

Remote MCP server to integrate and validate self-hosted PayRam deployments.

Uptime
100.0%
1 direct probes · 30d
Response
1184ms
last probe
Tools
52
callable
Resources
2
readable
Prompts
4
available
Primary URL
https://mcp.payram.com/mcp

Tools · 52

test_payram_connection

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.

payram_doctor

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…

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 …

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.

assess_payram_project

Inspects dependency files, frameworks, and .env status to suggest the next integration actions.

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 fir…

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

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 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 Sepol…

onboard_agent_setup

Returns the complete autonomous agent setup guide for deploying Payram without any web UI or human interaction.

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.

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.

get_payment_summary

Returns payment counts: total, open, closed, and cancelled. Useful for a quick overview of payment activity.

lookup_payment

Look up payments by transaction hash, email, reference ID, customer ID, or invoice ID. Returns up to 5 matching payments with full details.

search_payments

Search and filter payments with full control over status, network, currency, dates, webhook status, and pagination. Returns a paginated list of matching payments.

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…

get_daily_volume

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.

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 discov…

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…

create_payment_link

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

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 blo…

restart_payram_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…

check_payment_readiness

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 poin…

Resources · 2

Payram Setup Guide

Complete guide for setting up Payram in your project

payram://docs/setup-guide
Payram API Reference

API endpoints and SDK methods reference

payram://docs/api-reference

Prompts · 4

setup-payram

Interactive guide to set up Payram for the first time

setup-payram-agent

Autonomous agent guide to deploy and configure Payram with no web UI

integrate-payment

Guide to integrate payment acceptance into your application

troubleshoot-payment

Debug common payment integration issues

How to use

Add to your Claude Desktop / Cursor / Cline MCP config:

{
  "mcpServers": {
    "payram_helper_mcp_server": {
      "url": "https://mcp.payram.com/mcp",
      "transport": "http"
    }
  }
}