// MCP TOOL REFERENCE

PAYRAM HELPER MCP SERVER TOOLS

49 tools from the PayRam Helper MCP Server MCP Server, categorised by risk level.

View the PayRam Helper MCP Server policy → Token cost: 4,590 tokens →

// ALL 49 PAYRAM HELPER MCP SERVER TOOLS

READ 17 tools

Read check_node_sync Reports whether PayRam blockchain listener workers are running and whether each chain’s RPC nodes are conne... Read check_payment_readiness Diagnoses what is NOT yet set up to accept payments, per blockchain: missing deposit wallet, chain/currency... Read get_agent_setup_flow Returns the step-by-step setup flow for deploying PayRam as an agent. Covers install, wallet creation, fauc... Read get_daily_volume Returns the total payment volume for a given date, with breakdowns by network and currency. Only counts clo... Read get_payment_summary Returns payment counts: total, open, closed, and cancelled. Useful for a quick overview of payment activity. Read get_payram_doc_by_id Returns the markdown for a Payram doc given its id, e.g. "features/payouts". Read get_payram_links Surface official documentation, website, and community links. Read get_referral_dashboard_guide Explain how to embed and manage the referral dashboard experience. Read get_unswept_balances Returns unswept (unsettled) balances across all wallets, broken down by blockchain and currency. Shows swee... Read list_currencies Lists every blockchain currency PayRam supports on this node (chain code, network, currency code). Public e... Read list_payram_docs Lists the available Payram doc ids relative to docs/payram-docs-live. Optionally scope by a prefix such as ... Read list_platforms Lists all external platforms (projects) for the authenticated user. Use this to discover your platform ID, ... Read list_recipients Lists saved withdrawal recipients (payout beneficiaries). Use this to find a recipient ID for the 3-step pa... Read lookup_payment Look up payments by transaction hash, email, reference ID, customer ID, or invoice ID. Returns up to 5 matc... Read prepare_payram_test Confirm hosting, credentials, and environment variables before generating demo apps. Read search_payments Search and filter payments with full control over status, network, currency, dates, webhook status, and pag... Read test_payram_connection Checks the /api/v1/payment endpoint on a Payram server using baseUrl and apiKey. If they are not provided, ...

WRITE 31 tools

Write assess_payram_project Inspects dependency files, frameworks, and .env status to suggest the next integration actions. Write explain_payment_flow Describe how payments move from customer initiation through settlement. Write explain_payram_basics Explain Payram's product pillars, architecture, payments, and payouts capabilities. Write explain_payram_concepts Glossary-backed explanation of Payram terminology and constraints. Write explain_referral_flow Detail the referrer/referee lifecycle and required APIs. Write explain_referrals_basics Summarize how Payram referral campaigns are configured and managed. Write generate_env_template Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server. Write generate_mock_webhook_event Generates a snippet to send mock Payram webhook events to your local endpoint for testing. Write generate_payment_http_snippet Generates a raw HTTP sample for creating a Payram payment in the requested language. Write generate_payment_route_snippet Generates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment. Write generate_payment_sdk_snippet Generates backend code using the official Payram JS/TS SDK to create a payment. Write generate_payment_status_snippet Generates backend code to query the status of a Payram payment. Write generate_payout_recipient_flow_snippet Generates the recommended OTP-verified payout flow: create recipient → validate OTP → create payout against... Write generate_payout_sdk_snippet Generates a backend code snippet for creating a payout using the Payram JS/TS SDK. Write generate_payout_status_snippet Generates backend code to query the status of a payout using the Payram SDK. Write generate_referral_route_snippet Generates a backend route such as /api/referrals/create for logging referral events. Write generate_referral_sdk_snippet Generates a backend route or service snippet to create a referral event using the Payram SDK. Write generate_referral_status_snippet Generates code to fetch referral progress, rewards, or status. Write generate_referral_validation_snippet Generates a snippet to validate referral IDs, statuses, and eligibility. Write generate_setup_checklist Returns a step-by-step checklist of everything a merchant must configure to start using Payram. Write generate_webhook_event_router Generates a backend event router that dispatches Payram webhook events to domain handlers. Write generate_webhook_handler Generates backend code to handle Payram webhook HTTP requests. Write onboard_agent_setup Returns the complete autonomous agent setup guide for deploying Payram without any web UI or human interact... Write scaffold_payram_app Generates a minimal full-stack app skeleton with Payram payments and payouts routes (and a simple UI) for a... Write snippet_express_payment_route Returns an Express router that posts to Payram's /api/v1/payment endpoint. Write snippet_fastapi_payment_route Returns a FastAPI handler that calls Payram's create-payment HTTP API. Write snippet_go_payment_handler Returns a Gin handler that proxies /api/pay/create to Payram's create-payment API. Write snippet_laravel_payment_route Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint. Write snippet_nextjs_payment_route Returns a Next.js App Router API route that calls Payram's create-payment HTTP API. Write snippet_spring_payment_controller Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint. Write suggest_file_structure Suggests a recommended backend folder/file structure for integrating Payram.

FINANCIAL 1 tools

Financial create_payment_link Creates a PayRam checkout (payment) link and returns the hosted URL plus a reference_id. Authenticates with...

// FAQ

How many tools does the PayRam Helper MCP Server MCP server have? +

The PayRam Helper MCP Server MCP server exposes 49 tools across 3 categories: Read, Write, Financial.

How do I enforce policies on PayRam Helper MCP Server tools? +

Route the PayRam Helper MCP Server server through the PolicyLayer gateway. Define allow, deny, or approval rules per tool in the dashboard — they are enforced on every call before it reaches the server.

What risk categories do PayRam Helper MCP Server tools fall into? +

PayRam Helper MCP Server tools are categorised as Read (17), Write (31), Financial (1). Each category has a recommended default policy.

Let agents act without letting them run wild.

Route your MCP servers through PolicyLayer and every tool call is checked against your policy before it runs — allow, deny, or require approval. Per-identity grants. Full audit log. Live in minutes.

SECURE YOUR MCP →

Free to start. No card required.

4,600+ MCP servers and 31,000+ tools scanned and risk-classified.