API Tools
payram.com
Provides tools for testing, diagnosing, and generating integration code for the Payram payment API.
ENDPOINT 1
https://mcp.payram.com/mcp
Known tools 51
test_payram_connectionChecks the /api/v1/payment endpoint on a Payram server using baseUrl and apiKey.
payram_doctorStaged, read-only health diagnosis: server reachability -> merchant API key -> admin JWT -> payment readiness (wallets + listener workers).
generate_payment_sdk_snippetGenerates backend code using the official Payram JS/TS SDK to create a payment.
generate_payment_http_snippetGenerates a raw HTTP sample for creating a Payram payment in the requested language.
generate_payment_status_snippetGenerates backend code to query the status of a Payram payment.
generate_payment_route_snippetGenerates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment.
snippet_nextjs_payment_routeReturns a Next.js App Router API route that calls Payram's create-payment HTTP API.
snippet_express_payment_routeReturns an Express router that posts to Payram's /api/v1/payment endpoint.
snippet_fastapi_payment_routeReturns a FastAPI handler that calls Payram's create-payment HTTP API.
snippet_laravel_payment_routeReturns a Laravel controller that posts to Payram's /api/v1/payment endpoint.
snippet_go_payment_handlerReturns a Gin handler that proxies /api/pay/create to Payram's create-payment API.
snippet_spring_payment_controllerReturns a Spring Boot controller that calls Payram's /api/v1/payment endpoint.
generate_payout_sdk_snippetGenerates a backend code snippet for creating a payout using the Payram JS/TS SDK.
generate_payout_status_snippetGenerates backend code to query the status of a payout using the Payram SDK.
generate_payout_recipient_flow_snippetGenerates the recommended OTP-verified payout flow: create recipient → validate OTP → create payout against the saved recipient.
generate_referral_sdk_snippetGenerates a backend route or service snippet to create a referral event using the Payram SDK.
generate_referral_validation_snippetGenerates a snippet to validate referral IDs, statuses, and eligibility.
generate_referral_status_snippetGenerates code to fetch referral progress, rewards, or status.
generate_referral_route_snippetGenerates a backend route such as /api/referrals/create for logging referral events.
generate_webhook_handlerGenerates backend code to handle Payram webhook HTTP requests.
generate_webhook_event_routerGenerates a backend event router that dispatches Payram webhook events to domain handlers.
generate_mock_webhook_eventGenerates a snippet to send mock Payram webhook events to your local endpoint for testing.
assess_payram_projectInspects dependency files, frameworks, and .env status to suggest the next integration actions.
explain_payram_basicsExplain Payram's product pillars, architecture, payments, and payouts capabilities.
get_payram_linksSurface official documentation, website, and community links.
explain_payment_flowDescribe how payments move from customer initiation through settlement.
explain_payram_conceptsGlossary-backed explanation of Payram terminology and constraints.
explain_referrals_basicsSummarize how Payram referral campaigns are configured and managed.
explain_referral_flowDetail the referrer/referee lifecycle and required APIs.
get_referral_dashboard_guideExplain how to embed and manage the referral dashboard experience.
prepare_payram_testConfirm hosting, credentials, and environment variables before generating demo apps.
get_payram_doc_by_idReturns the markdown for a Payram doc given its id, e.g.
list_payram_docsLists the available Payram doc ids relative to docs/payram-docs-live.
generate_env_templateCreates a .env template for configuring a merchant backend to talk to a self-hosted Payram server.
generate_setup_checklistReturns a step-by-step checklist of everything a merchant must configure to start using Payram.
suggest_file_structureSuggests a recommended backend folder/file structure for integrating Payram.
get_agent_setup_flowReturns the step-by-step setup flow for deploying PayRam as an agent.
onboard_agent_setupReturns the complete autonomous agent setup guide for deploying Payram without any web UI or human interaction.
scaffold_payram_appGenerates a minimal full-stack app skeleton with Payram payments and payouts routes (and a simple UI) for a chosen language and framework.
list_platformsLists all external platforms (projects) for the authenticated user.
get_payment_summaryReturns payment counts: total, open, closed, and cancelled.
lookup_paymentLook up payments by transaction hash, email, reference ID, customer ID, or invoice ID.
search_paymentsSearch and filter payments with full control over status, network, currency, dates, webhook status, and pagination.
get_unswept_balancesReturns unswept (unsettled) balances across all wallets, broken down by blockchain and currency.
get_daily_volumeReturns the total payment volume for a given date, with breakdowns by network and currency.
list_currenciesLists every blockchain currency PayRam supports on this node (chain code, network, currency code).
list_recipientsLists saved withdrawal recipients (payout beneficiaries).
create_payment_linkCreates a PayRam checkout (payment) link and returns the hosted URL plus a reference_id.
check_node_syncPer-chain node health verdict: healthy / lagging / unreachable / listener-down.
restart_payram_workerREMEDIATION ACTION (write): restarts a blockchain listener worker via supervisor — the minimal fix when check_node_sync reports a chain as lagging or listener-down.
check_payment_readinessDiagnoses 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.