# PayRam Helper MCP Server MCP server

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

## Links
- Registry page: https://www.getdrio.com/mcp/io-github-payram-payram-helper-mcp
- Repository: https://github.com/PayRam/payram-helper-mcp-server

## Install
- Endpoint: https://mcp.payram.com/
- Auth: Not captured

## Setup notes
- Remote endpoint: https://mcp.payram.com/
- Remote endpoint: https://mcp.payram.com/mcp
- Remote endpoint: https://mcp.payram.com/mcp/sse

## Tools
- test_payram_connection (Test Payram Connectivity) - 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. Endpoint: https://mcp.payram.com/
- generate_payment_sdk_snippet (Generate SDK payment snippet) - Generates backend code using the official Payram JS/TS SDK to create a payment. Endpoint: https://mcp.payram.com/
- generate_payment_http_snippet (Generate HTTP payment snippet) - Generates a raw HTTP sample for creating a Payram payment in the requested language. Endpoint: https://mcp.payram.com/
- generate_payment_status_snippet (Generate payment status snippet) - Generates backend code to query the status of a Payram payment. Endpoint: https://mcp.payram.com/
- generate_payment_route_snippet (Generate payment route snippet) - Generates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment. Endpoint: https://mcp.payram.com/
- snippet_nextjs_payment_route (Next.js create-payment route snippet) - Returns a Next.js App Router API route that calls Payram's create-payment HTTP API. Endpoint: https://mcp.payram.com/
- snippet_express_payment_route (Express create-payment route snippet) - Returns an Express router that posts to Payram's /api/v1/payment endpoint. Endpoint: https://mcp.payram.com/
- snippet_fastapi_payment_route (FastAPI create-payment route snippet) - Returns a FastAPI handler that calls Payram's create-payment HTTP API. Endpoint: https://mcp.payram.com/
- snippet_laravel_payment_route (Laravel create-payment route snippet) - Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint. Endpoint: https://mcp.payram.com/
- snippet_go_payment_handler (Go (Gin) create-payment route snippet) - Returns a Gin handler that proxies /api/pay/create to Payram's create-payment API. Endpoint: https://mcp.payram.com/
- snippet_spring_payment_controller (Spring Boot create-payment controller snippet) - Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint. Endpoint: https://mcp.payram.com/
- generate_payout_sdk_snippet (Generate payout SDK snippet) - Generates a backend code snippet for creating a payout using the Payram JS/TS SDK. Endpoint: https://mcp.payram.com/
- generate_payout_status_snippet (Generate payout status SDK snippet) - Generates backend code to query the status of a payout using the Payram SDK. Endpoint: https://mcp.payram.com/
- generate_referral_sdk_snippet (Generate referral SDK snippet) - Generates a backend route or service snippet to create a referral event using the Payram SDK. Endpoint: https://mcp.payram.com/
- generate_referral_validation_snippet (Generate referral validation snippet) - Generates a snippet to validate referral IDs, statuses, and eligibility. Endpoint: https://mcp.payram.com/
- generate_referral_status_snippet (Generate referral status snippet) - Generates code to fetch referral progress, rewards, or status. Endpoint: https://mcp.payram.com/
- generate_referral_route_snippet (Generate referral route snippet) - Generates a backend route such as /api/referrals/create for logging referral events. Endpoint: https://mcp.payram.com/
- generate_webhook_handler (Generate Payram webhook HTTP handler) - Generates backend code to handle Payram webhook HTTP requests. Endpoint: https://mcp.payram.com/
- generate_webhook_event_router (Generate Payram webhook event router) - Generates a backend event router that dispatches Payram webhook events to domain handlers. Endpoint: https://mcp.payram.com/
- generate_mock_webhook_event (Generate mock Payram webhook event) - Generates a snippet to send mock Payram webhook events to your local endpoint for testing. Endpoint: https://mcp.payram.com/
- assess_payram_project (Assess Payram readiness in an existing codebase) - Inspects dependency files, frameworks, and .env status to suggest the next integration actions. Endpoint: https://mcp.payram.com/
- explain_payram_basics (Payram Basics Overview) - Explain Payram's product pillars, architecture, payments, and payouts capabilities. Endpoint: https://mcp.payram.com/
- get_payram_links (Payram Important Links) - Surface official documentation, website, and community links. Endpoint: https://mcp.payram.com/
- explain_payment_flow (Payment Flow Guide) - Describe how payments move from customer initiation through settlement. Endpoint: https://mcp.payram.com/
- explain_payram_concepts (Core Payram Concepts) - Glossary-backed explanation of Payram terminology and constraints. Endpoint: https://mcp.payram.com/
- explain_referrals_basics (Referral Basics Overview) - Summarize how Payram referral campaigns are configured and managed. Endpoint: https://mcp.payram.com/
- explain_referral_flow (Referral Flow Guide) - Detail the referrer/referee lifecycle and required APIs. Endpoint: https://mcp.payram.com/
- get_referral_dashboard_guide (Referral Dashboard Guide) - Explain how to embed and manage the referral dashboard experience. Endpoint: https://mcp.payram.com/
- prepare_payram_test (Payram Test Readiness Checklist) - Confirm hosting, credentials, and environment variables before generating demo apps. Endpoint: https://mcp.payram.com/
- get_payram_doc_by_id (Get Payram Doc By ID) - Returns the markdown for a Payram doc given its id, e.g. "features/payouts". Endpoint: https://mcp.payram.com/
- list_payram_docs (List Payram Docs) - Lists the available Payram doc ids relative to docs/payram-docs-live. Optionally scope by a prefix such as "features". Endpoint: https://mcp.payram.com/
- generate_env_template (Generate Payram .env Template) - Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server. Endpoint: https://mcp.payram.com/
- generate_setup_checklist (Generate Payram Setup Checklist) - Returns a step-by-step checklist of everything a merchant must configure to start using Payram. Endpoint: https://mcp.payram.com/
- suggest_file_structure (Suggest Payram File Structure) - Suggests a recommended backend folder/file structure for integrating Payram. Endpoint: https://mcp.payram.com/
- get_agent_setup_flow (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. Endpoint: https://mcp.payram.com/
- onboard_agent_setup (Get Payram Agent Onboarding Guide) - Returns the complete autonomous agent setup guide for deploying Payram without any web UI or human interaction. Endpoint: https://mcp.payram.com/
- scaffold_payram_app (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. Endpoint: https://mcp.payram.com/
- list_platforms (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. Endpoint: https://mcp.payram.com/
- get_payment_summary (Get Payment Summary) - Returns payment counts: total, open, closed, and cancelled. Useful for a quick overview of payment activity. Endpoint: https://mcp.payram.com/
- lookup_payment (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. Endpoint: https://mcp.payram.com/
- search_payments (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. Endpoint: https://mcp.payram.com/
- get_unswept_balances (Get Unswept Balances) - Returns unswept (unsettled) balances across all wallets, broken down by blockchain and currency. Shows sweep readiness status for each entry (sweep, sweep_in_progress, sweep_not_allowed, no_balance). Endpoint: https://mcp.payram.com/
- get_daily_volume (Get Daily Volume) - Returns the total payment volume for a given date, with breakdowns by network and currency. Only counts closed (completed) payments. Defaults to today if no date is specified. Endpoint: https://mcp.payram.com/
- test_payram_connection (Test Payram Connectivity) - 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. Endpoint: https://mcp.payram.com/mcp
- generate_payment_sdk_snippet (Generate SDK payment snippet) - Generates backend code using the official Payram JS/TS SDK to create a payment. Endpoint: https://mcp.payram.com/mcp
- generate_payment_http_snippet (Generate HTTP payment snippet) - Generates a raw HTTP sample for creating a Payram payment in the requested language. Endpoint: https://mcp.payram.com/mcp
- generate_payment_status_snippet (Generate payment status snippet) - Generates backend code to query the status of a Payram payment. Endpoint: https://mcp.payram.com/mcp
- generate_payment_route_snippet (Generate payment route snippet) - Generates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment. Endpoint: https://mcp.payram.com/mcp
- snippet_nextjs_payment_route (Next.js create-payment route snippet) - Returns a Next.js App Router API route that calls Payram's create-payment HTTP API. Endpoint: https://mcp.payram.com/mcp
- snippet_express_payment_route (Express create-payment route snippet) - Returns an Express router that posts to Payram's /api/v1/payment endpoint. Endpoint: https://mcp.payram.com/mcp
- snippet_fastapi_payment_route (FastAPI create-payment route snippet) - Returns a FastAPI handler that calls Payram's create-payment HTTP API. Endpoint: https://mcp.payram.com/mcp
- snippet_laravel_payment_route (Laravel create-payment route snippet) - Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint. Endpoint: https://mcp.payram.com/mcp
- snippet_go_payment_handler (Go (Gin) create-payment route snippet) - Returns a Gin handler that proxies /api/pay/create to Payram's create-payment API. Endpoint: https://mcp.payram.com/mcp
- snippet_spring_payment_controller (Spring Boot create-payment controller snippet) - Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint. Endpoint: https://mcp.payram.com/mcp
- generate_payout_sdk_snippet (Generate payout SDK snippet) - Generates a backend code snippet for creating a payout using the Payram JS/TS SDK. Endpoint: https://mcp.payram.com/mcp
- generate_payout_status_snippet (Generate payout status SDK snippet) - Generates backend code to query the status of a payout using the Payram SDK. Endpoint: https://mcp.payram.com/mcp
- generate_referral_sdk_snippet (Generate referral SDK snippet) - Generates a backend route or service snippet to create a referral event using the Payram SDK. Endpoint: https://mcp.payram.com/mcp
- generate_referral_validation_snippet (Generate referral validation snippet) - Generates a snippet to validate referral IDs, statuses, and eligibility. Endpoint: https://mcp.payram.com/mcp
- generate_referral_status_snippet (Generate referral status snippet) - Generates code to fetch referral progress, rewards, or status. Endpoint: https://mcp.payram.com/mcp
- generate_referral_route_snippet (Generate referral route snippet) - Generates a backend route such as /api/referrals/create for logging referral events. Endpoint: https://mcp.payram.com/mcp
- generate_webhook_handler (Generate Payram webhook HTTP handler) - Generates backend code to handle Payram webhook HTTP requests. Endpoint: https://mcp.payram.com/mcp
- generate_webhook_event_router (Generate Payram webhook event router) - Generates a backend event router that dispatches Payram webhook events to domain handlers. Endpoint: https://mcp.payram.com/mcp
- generate_mock_webhook_event (Generate mock Payram webhook event) - Generates a snippet to send mock Payram webhook events to your local endpoint for testing. Endpoint: https://mcp.payram.com/mcp
- assess_payram_project (Assess Payram readiness in an existing codebase) - Inspects dependency files, frameworks, and .env status to suggest the next integration actions. Endpoint: https://mcp.payram.com/mcp
- explain_payram_basics (Payram Basics Overview) - Explain Payram's product pillars, architecture, payments, and payouts capabilities. Endpoint: https://mcp.payram.com/mcp
- get_payram_links (Payram Important Links) - Surface official documentation, website, and community links. Endpoint: https://mcp.payram.com/mcp
- explain_payment_flow (Payment Flow Guide) - Describe how payments move from customer initiation through settlement. Endpoint: https://mcp.payram.com/mcp
- explain_payram_concepts (Core Payram Concepts) - Glossary-backed explanation of Payram terminology and constraints. Endpoint: https://mcp.payram.com/mcp
- explain_referrals_basics (Referral Basics Overview) - Summarize how Payram referral campaigns are configured and managed. Endpoint: https://mcp.payram.com/mcp
- explain_referral_flow (Referral Flow Guide) - Detail the referrer/referee lifecycle and required APIs. Endpoint: https://mcp.payram.com/mcp
- get_referral_dashboard_guide (Referral Dashboard Guide) - Explain how to embed and manage the referral dashboard experience. Endpoint: https://mcp.payram.com/mcp
- prepare_payram_test (Payram Test Readiness Checklist) - Confirm hosting, credentials, and environment variables before generating demo apps. Endpoint: https://mcp.payram.com/mcp
- get_payram_doc_by_id (Get Payram Doc By ID) - Returns the markdown for a Payram doc given its id, e.g. "features/payouts". Endpoint: https://mcp.payram.com/mcp
- list_payram_docs (List Payram Docs) - Lists the available Payram doc ids relative to docs/payram-docs-live. Optionally scope by a prefix such as "features". Endpoint: https://mcp.payram.com/mcp
- generate_env_template (Generate Payram .env Template) - Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server. Endpoint: https://mcp.payram.com/mcp
- generate_setup_checklist (Generate Payram Setup Checklist) - Returns a step-by-step checklist of everything a merchant must configure to start using Payram. Endpoint: https://mcp.payram.com/mcp
- suggest_file_structure (Suggest Payram File Structure) - Suggests a recommended backend folder/file structure for integrating Payram. Endpoint: https://mcp.payram.com/mcp
- get_agent_setup_flow (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. Endpoint: https://mcp.payram.com/mcp
- onboard_agent_setup (Get Payram Agent Onboarding Guide) - Returns the complete autonomous agent setup guide for deploying Payram without any web UI or human interaction. Endpoint: https://mcp.payram.com/mcp
- scaffold_payram_app (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. Endpoint: https://mcp.payram.com/mcp
- list_platforms (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. Endpoint: https://mcp.payram.com/mcp
- get_payment_summary (Get Payment Summary) - Returns payment counts: total, open, closed, and cancelled. Useful for a quick overview of payment activity. Endpoint: https://mcp.payram.com/mcp
- lookup_payment (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. Endpoint: https://mcp.payram.com/mcp
- search_payments (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. Endpoint: https://mcp.payram.com/mcp
- get_unswept_balances (Get Unswept Balances) - Returns unswept (unsettled) balances across all wallets, broken down by blockchain and currency. Shows sweep readiness status for each entry (sweep, sweep_in_progress, sweep_not_allowed, no_balance). Endpoint: https://mcp.payram.com/mcp
- get_daily_volume (Get Daily Volume) - Returns the total payment volume for a given date, with breakdowns by network and currency. Only counts closed (completed) payments. Defaults to today if no date is specified. Endpoint: https://mcp.payram.com/mcp

## Resources
- payram://docs/setup-guide - Complete guide for setting up Payram in your project MIME type: text/markdown
- payram://docs/api-reference - API endpoints and SDK methods reference MIME type: text/markdown
- payram://docs/setup-guide - Complete guide for setting up Payram in your project MIME type: text/markdown
- payram://docs/api-reference - API endpoints and SDK methods reference MIME type: text/markdown

## Prompts
- setup-payram - Setup Payram Interactive guide to set up Payram for the first time
- setup-payram-agent - Setup Payram Agent Autonomous agent guide to deploy and configure Payram with no web UI
- integrate-payment - Integrate Payment Guide to integrate payment acceptance into your application Arguments: framework
- troubleshoot-payment - Troubleshoot Payment Debug common payment integration issues Arguments: issue
- setup-payram - Setup Payram Interactive guide to set up Payram for the first time
- setup-payram-agent - Setup Payram Agent Autonomous agent guide to deploy and configure Payram with no web UI
- integrate-payment - Integrate Payment Guide to integrate payment acceptance into your application Arguments: framework
- troubleshoot-payment - Troubleshoot Payment Debug common payment integration issues Arguments: issue

## Metadata
- Owner: io.github.PayRam
- Version: 1.1.0
- Runtime: Sse, Streamable Http
- Transports: HTTP
- License: Not captured
- Language: Not captured
- Stars: Not captured
- Updated: Feb 17, 2026
- Source: https://registry.modelcontextprotocol.io