MCP Radar
MCP Server

PayRam Helper MCP Server

io.github.PayRam/payram-helper-mcp
Crypto & Web3 Developer Tools Payments & Fintech Public & reachable MCP 2025-11-25

What this MCP does

Helps integrate and operate self-hosted PayRam crypto payment and payout systems with readiness checks, payment links, status flows, and code snippets.

Capabilities

Tools

52 tools
assess_payram_project
Assess Payram readiness in an existing codebase
Inspects dependency files, frameworks, and .env status to suggest the next integration actions.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['summary', 'packageManagers', 'frameworks', 'envStatus', 'payramDependencies', 'recommendedNextSteps'], 'properties': {'summary': {'type': 'string'}, 'envStatus': {'type': 'object', 'required': ['fileFound', 'variables'], 'properties': {'notes': {'type': 'string'}, 'envPath': {'type': 'string'}, 'fileFound': {'type': 'boolean'}, 'variables': {'type': 'array', 'items': {'type': 'object', 'required': ['key', 'present'], 'properties': {'key': {'type': 'string'}, 'present': {'type': 'boolean'}, 'placeholder': {'type': 'boolean'}, 'valuePreview': {'type': 'string'}}, 'additionalProperties': False}}}, 'additionalProperties': False}, 'frameworks': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'language', 'confidence', 'evidence'], 'properties': {'name': {'type': 'string'}, 'evidence': {'type': 'array', 'items': {'type': 'string'}}, 'language': {'type': 'string'}, 'confidence': {'enum': ['high', 'medium', 'low'], 'type': 'string'}, 'recommendedTools': {'type': 'array', 'items': {'type': 'string'}}}, 'additionalProperties': False}}, 'detectedFiles': {'type': 'array', 'items': {'type': 'string'}}, 'packageManagers': {'type': 'array', 'items': {'type': 'object', 'required': ['type', 'path'], 'properties': {'path': {'type': 'string'}, 'type': {'type': 'string'}}, 'additionalProperties': False}}, 'payramDependencies': {'type': 'array', 'items': {'type': 'object', 'required': ['packageName', 'source'], 'properties': {'source': {'type': 'string'}, 'version': {'type': 'string'}, 'packageName': {'type': 'string'}}, 'additionalProperties': False}}, 'recommendedNextSteps': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'label', 'detail'], 'properties': {'id': {'type': 'string'}, 'tool': {'type': 'string'}, 'label': {'type': 'string'}, 'detail': {'type': 'string'}}, 'additionalProperties': False}}}, 'additionalProperties': False}
check_node_sync
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['workers', 'chains', 'issues', 'healthy', 'workersAvailable'], 'properties': {'chains': {'type': 'array', 'items': {'type': 'object', 'required': ['blockchainCode', 'verdict', 'staleThresholdSeconds', 'listenerWorker', 'listenerRunning', 'reachable', 'oldestBlockAgeSeconds', 'nodes'], 'properties': {'note': {'type': 'string'}, 'nodes': {'type': 'array', 'items': {'type': 'object', 'required': ['url', 'connected', 'stale'], 'properties': {'url': {'type': 'string'}, 'error': {'type': 'string'}, 'stale': {'type': 'boolean'}, 'connected': {'type': 'boolean'}, 'avgLatencyMs': {'type': 'number'}, 'lastBlockSeen': {'type': 'number'}, 'blockAgeSeconds': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'verdict': {'enum': ['healthy', 'lagging', 'unreachable', 'listener-down'], 'type': 'string'}, 'reachable': {'type': 'boolean'}, 'blockchainCode': {'type': 'string'}, 'listenerWorker': {'type': 'string'}, 'listenerRunning': {'type': 'boolean'}, 'oldestBlockAgeSeconds': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'staleThresholdSeconds': {'type': 'number'}}, 'additionalProperties': False}}, 'issues': {'type': 'array', 'items': {'type': 'string'}}, 'healthy': {'type': 'boolean'}, 'workers': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'status', 'details'], 'properties': {'name': {'type': 'string'}, 'status': {'type': 'string'}, 'details': {'type': 'string'}}, 'additionalProperties': {}}}, 'workersAvailable': {'type': 'boolean'}}, 'additionalProperties': False}
check_payment_readiness
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 points to the CLI for wallet setup; it does not create wallets itself.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'externalPlatformId': {'type': 'string', 'description': 'Project/platform ID to check currency enablement for (auto-resolved if omitted)'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['projectId', 'readyChains', 'chains', 'allReady'], 'properties': {'chains': {'type': 'array', 'items': {'type': 'object', 'required': ['blockchainCode', 'name', 'family', 'hasDepositWallet', 'enabledForProject', 'listenerRunning', 'ready', 'missing'], 'properties': {'name': {'type': 'string'}, 'ready': {'type': 'boolean'}, 'family': {'type': 'string'}, 'missing': {'type': 'array', 'items': {'type': 'string'}}, 'blockchainCode': {'type': 'string'}, 'listenerRunning': {'type': 'boolean'}, 'hasDepositWallet': {'type': 'boolean'}, 'enabledForProject': {'type': 'boolean'}}, 'additionalProperties': False}}, 'allReady': {'type': 'boolean'}, 'projectId': {'type': 'string'}, 'readyChains': {'type': 'array', 'items': {'type': 'string'}}}, 'additionalProperties': False}
create_payment_link
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. The customer chooses the chain/currency on the hosted checkout. Poll status later with lookup_payment (or GET /api/v1/payment/reference/{reference_id}).
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['amountInUSD', 'customerID', 'customerEmail'], 'properties': {'customerID': {'type': 'string', 'minLength': 1, 'description': 'Your internal customer identifier (sent as customerID, required)'}, 'amountInUSD': {'type': 'number', 'description': 'Payment amount in USD (must be > 0)', 'exclusiveMinimum': 0}, 'customerEmail': {'type': 'string', 'format': 'email', 'pattern': "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", 'description': 'Customer email (required — the backend validates it as a non-empty email)'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['url', 'reference_id'], 'properties': {'url': {'type': 'string'}, 'host': {'type': 'string'}, 'reference_id': {'type': 'string'}}, 'additionalProperties': {}}
explain_payment_flow
Payment Flow Guide
Describe how payments move from customer initiation through settlement.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
explain_payram_basics
Payram Basics Overview
Explain Payram's product pillars, architecture, payments, and payouts capabilities.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
explain_payram_concepts
Core Payram Concepts
Glossary-backed explanation of Payram terminology and constraints.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
explain_referral_flow
Referral Flow Guide
Detail the referrer/referee lifecycle and required APIs.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
explain_referrals_basics
Referral Basics Overview
Summarize how Payram referral campaigns are configured and managed.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
generate_env_template
Generate Payram .env Template
Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'envExample', 'variables'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'variables': {'type': 'array', 'items': {'type': 'object', 'required': ['key', 'required', 'description'], 'properties': {'key': {'type': 'string'}, 'example': {'type': 'string'}, 'docsRefs': {'type': 'array', 'items': {'type': 'string'}}, 'required': {'type': 'boolean'}, 'description': {'type': 'string'}, 'defaultValue': {'type': 'string'}}, 'additionalProperties': False}}, 'envExample': {'type': 'string'}, 'description': {'type': 'string'}}, 'additionalProperties': False}
generate_mock_webhook_event
Generate mock Payram webhook event
Generates a snippet to send mock Payram webhook events to your local endpoint for testing.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['language', 'status'], 'properties': {'status': {'enum': ['OPEN', 'CANCELLED', 'FILLED', 'PARTIALLY_FILLED', 'OVER_FILLED', 'UNDEFINED'], 'type': 'string', 'description': 'Payment status to simulate in the mock webhook event'}, 'language': {'enum': ['curl', 'python', 'go', 'php', 'java'], 'type': 'string', 'description': 'Language/tool for the mock webhook request (curl for command-line testing)'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['express', 'nextjs', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_payment_http_snippet
Generate HTTP payment snippet
Generates a raw HTTP sample for creating a Payram payment in the requested language.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['language'], 'properties': {'language': {'enum': ['python', 'go', 'php', 'java'], 'type': 'string', 'description': 'Programming language for the HTTP payment creation snippet'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['framework'], 'properties': {'framework': {'enum': ['express', 'nextjs'], 'type': 'string', 'description': 'Web framework for the payment route handler (Express.js or Next.js)'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_payment_sdk_snippet
Generate SDK payment snippet
Generates backend code using the official Payram JS/TS SDK to create a payment.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['framework'], 'properties': {'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string', 'description': 'Target framework for the SDK payment snippet. generic-http provides a framework-agnostic example.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_payment_status_snippet
Generate payment status snippet
Generates backend code to query the status of a Payram payment.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['style'], 'properties': {'style': {'enum': ['sdk', 'http'], 'type': 'string', 'description': 'Style of code snippet: sdk uses the Payram SDK, http uses raw HTTP requests'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_payout_recipient_flow_snippet
Generate 3-step recipient payout 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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript'], 'type': 'string'}, 'framework': {'enum': ['generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_payout_sdk_snippet
Generate payout SDK snippet
Generates a backend code snippet for creating a payout using the Payram JS/TS SDK.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['framework'], 'properties': {'framework': {'enum': ['generic-http'], 'type': 'string', 'description': 'Target framework for the payout SDK snippet'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript'], 'type': 'string'}, 'framework': {'enum': ['generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_payout_status_snippet
Generate payout status SDK snippet
Generates backend code to query the status of a payout using the Payram SDK.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript'], 'type': 'string'}, 'framework': {'enum': ['generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_referral_route_snippet
Generate referral route snippet
Generates a backend route such as /api/referrals/create for logging referral events.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['framework'], 'properties': {'framework': {'enum': ['express', 'nextjs'], 'type': 'string', 'description': 'Web framework for the referral route handler (Express.js or Next.js)'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_referral_sdk_snippet
Generate referral SDK snippet
Generates a backend route or service snippet to create a referral event using the Payram SDK.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['framework'], 'properties': {'framework': {'enum': ['generic-http'], 'type': 'string', 'description': 'Target framework for the referral SDK snippet'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_referral_status_snippet
Generate referral status snippet
Generates code to fetch referral progress, rewards, or status.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['style'], 'properties': {'style': {'enum': ['sdk', 'backend-only'], 'type': 'string', 'description': 'Style of code snippet: sdk uses the Payram SDK, backend-only shows direct API calls'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_referral_validation_snippet
Generate referral validation snippet
Generates a snippet to validate referral IDs, statuses, and eligibility.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript'], 'type': 'string'}, 'framework': {'enum': ['generic-http', 'express', 'nextjs'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_setup_checklist
Generate Payram Setup Checklist
Returns a step-by-step checklist of everything a merchant must configure to start using Payram.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'items'], 'properties': {'items': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'label', 'description'], 'properties': {'id': {'type': 'string'}, 'label': {'type': 'string'}, 'docsRefs': {'type': 'array', 'items': {'type': 'string'}}, 'optional': {'type': 'boolean'}, 'description': {'type': 'string'}}, 'additionalProperties': False}}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'description': {'type': 'string'}}, 'additionalProperties': False}
generate_topup_integration_snippet
Generate top-up wallet integration
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.)
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'part': {'enum': ['schema', 'webhook', 'settle', 'all'], 'type': 'string', 'default': 'all', 'description': "Which piece to emit: 'schema' (ledger DDL), 'webhook' (cumulative-credit handler), 'settle' (atomic invoice debit), or 'all'."}, 'framework': {'enum': ['express', 'fastapi'], 'type': 'string', 'default': 'express', 'description': 'Server framework for the webhook handler + settle function.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'notes'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_webhook_event_router
Generate Payram webhook event router
Generates a backend event router that dispatches Payram webhook events to domain handlers.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['express', 'nextjs', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
generate_webhook_handler
Generate Payram webhook HTTP handler
Generates backend code to handle Payram webhook HTTP requests.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['framework'], 'properties': {'framework': {'enum': ['express', 'nextjs', 'fastapi', 'gin', 'laravel', 'spring-boot'], 'type': 'string', 'description': 'Web framework for the webhook handler code'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['express', 'nextjs', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'markdown'], 'properties': {'title': {'type': 'string'}, 'markdown': {'type': 'string'}, 'description': {'type': 'string'}}, 'additionalProperties': False}
get_daily_volume
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'date': {'type': 'string', 'description': 'Date in YYYY-MM-DD format. Defaults to today (UTC).'}, 'externalPlatformId': {'type': 'string', 'description': 'Optional. Auto-discovered from your account if omitted.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['date', 'totalPayments', 'totalVolumeUSD', 'byNetwork', 'byCurrency'], 'properties': {'date': {'type': 'string'}, 'byNetwork': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'count', 'volumeUSD'], 'properties': {'name': {'type': 'string'}, 'count': {'type': 'number'}, 'volumeUSD': {'type': 'number'}}, 'additionalProperties': False}}, 'byCurrency': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'count', 'volumeUSD'], 'properties': {'name': {'type': 'string'}, 'count': {'type': 'number'}, 'volumeUSD': {'type': 'number'}}, 'additionalProperties': False}}, 'totalPayments': {'type': 'number'}, 'totalVolumeUSD': {'type': 'number'}}, 'additionalProperties': False}
get_payment_summary
Get Payment Summary
Returns payment counts: total, open, closed, and cancelled. Useful for a quick overview of payment activity.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'externalPlatformId': {'type': 'string', 'description': 'Optional. Auto-discovered from your account if omitted.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['totalCount', 'openCount', 'closedCount', 'cancelledCount'], 'properties': {'openCount': {'type': 'number'}, 'totalCount': {'type': 'number'}, 'closedCount': {'type': 'number'}, 'cancelledCount': {'type': 'number'}}, 'additionalProperties': False}
get_payram_doc_by_id
Get Payram Doc By ID
Returns the markdown for a Payram doc given its id, e.g. "features/payouts".
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1}}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id', 'path', 'markdown'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}
get_payram_links
Payram Important Links
Surface official documentation, website, and community links.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
get_referral_dashboard_guide
Referral Dashboard Guide
Explain how to embed and manage the referral dashboard experience.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
get_unswept_balances
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".
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['balances', 'totalWallets'], 'properties': {'balances': {'type': 'array', 'items': {'type': 'object', 'required': ['walletName', 'walletID', 'blockchainCode', 'blockchainFamily', 'currencyCode', 'amount', 'addressCount', 'action'], 'properties': {'action': {'type': 'string'}, 'amount': {'type': 'string'}, 'walletID': {'type': 'number'}, 'amountUSD': {'type': 'string'}, 'walletName': {'type': 'string'}, 'addressCount': {'type': 'number'}, 'currencyCode': {'type': 'string'}, 'walletActive': {'type': 'boolean'}, 'blockchainCode': {'type': 'string'}, 'lastSweepError': {'type': 'object', 'required': ['statusCode', 'category', 'reason', 'retryable', 'occurredAt', 'address'], 'properties': {'reason': {'type': 'string'}, 'txHash': {'type': 'string'}, 'address': {'type': 'string'}, 'category': {'type': 'string'}, 'retryable': {'type': 'boolean'}, 'actionHint': {'type': 'string'}, 'occurredAt': {'type': 'string'}, 'statusCode': {'type': 'string'}}, 'additionalProperties': {}}, 'hotWalletActive': {'type': 'boolean'}, 'blockchainFamily': {'type': 'string'}, 'hotWalletAddress': {'type': 'string'}, 'nextProbableSweepAt': {'type': 'string'}, 'coldWalletConfigured': {'type': 'boolean'}, 'sweepInProgressTxHash': {'type': 'string'}, 'isSCWDeploymentPending': {'type': 'boolean'}}, 'additionalProperties': {}}}, 'totalWallets': {'type': 'number'}}, 'additionalProperties': False}
list_currencies
List Supported 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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['currencies', 'count'], 'properties': {'count': {'type': 'number'}, 'currencies': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'blockchainCode', 'currencyCode'], 'properties': {'id': {'type': 'number'}, 'network': {'type': 'string'}, 'currency': {'type': 'string'}, 'currencyCode': {'type': 'string'}, 'blockchainCode': {'type': 'string'}}, 'additionalProperties': {}}}}, 'additionalProperties': False}
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".
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'prefix': {'type': 'string'}}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['count', 'docs'], 'properties': {'docs': {'type': 'array', 'items': {'type': 'string'}}, 'count': {'type': 'number'}, 'prefix': {'type': 'string'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['platforms', 'count'], 'properties': {'count': {'type': 'number'}, 'platforms': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'name'], 'properties': {'id': {'type': 'number'}, 'name': {'type': 'string'}, 'createdAt': {'type': 'string'}, 'referenceId': {'type': 'string'}}, 'additionalProperties': False}}}, 'additionalProperties': False}
list_recipients
List Payout 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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['recipients', 'count'], 'properties': {'count': {'type': 'number'}, 'recipients': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'blockchainCode', 'address', 'status'], 'properties': {'id': {'type': 'number'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'status': {'type': 'string'}, 'address': {'type': 'string'}, 'createdAt': {'type': 'string'}, 'updatedAt': {'type': 'string'}, 'blockchainCode': {'type': 'string'}}, 'additionalProperties': {}}}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['query'], 'properties': {'query': {'type': 'string', 'minLength': 1, 'description': 'Search query: transaction hash, email address, reference ID (UUID), customer ID, or invoice ID. The backend auto-detects the query type.'}, 'externalPlatformId': {'type': 'string', 'description': 'Optional. Auto-discovered from your account if omitted.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['payments', 'totalCount'], 'properties': {'payments': {'type': 'array', 'items': {'type': 'object', 'required': ['projectName', 'paymentStatus', 'createdBy'], 'properties': {'email': {'type': 'string'}, 'amount': {'type': 'number'}, 'txHash': {'type': 'string'}, 'blockId': {'type': 'number'}, 'network': {'type': 'string'}, 'currency': {'type': 'string'}, 'createdAt': {'type': 'string'}, 'createdBy': {'type': 'string'}, 'invoiceId': {'type': 'string'}, 'toAddress': {'type': 'string'}, 'updatedAt': {'type': 'string'}, 'customerId': {'type': 'string'}, 'amountInUSD': {'type': 'number'}, 'fromAddress': {'type': 'string'}, 'onRamperFee': {'type': 'number'}, 'projectName': {'type': 'string'}, 'referenceId': {'type': 'string'}, 'filledAmount': {'type': 'number'}, 'paymasterFee': {'type': 'number'}, 'trxTimestamp': {'type': 'string'}, 'paymentStatus': {'type': 'string'}, 'webhookStatus': {'type': 'string'}, 'onRamperFeeInUSD': {'type': 'number'}, 'filledAmountInUSD': {'type': 'number'}, 'paymasterFeeInUSD': {'type': 'number'}}, 'additionalProperties': False}}, 'totalCount': {'type': 'number'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'markdown'], 'properties': {'title': {'type': 'string'}, 'markdown': {'type': 'string'}, 'description': {'type': 'string'}}, 'additionalProperties': False}
payram_doctor
Diagnose a PayRam setup (one call)
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'apiKey': {'type': 'string', 'minLength': 1, 'description': 'Merchant API key (per-project). Defaults to PAYRAM_API_KEY. Obtain headlessly: ./setup_payram_agents.sh ensure-api-key'}, 'baseUrl': {'type': 'string', 'format': 'uri', 'description': 'PayRam server base URL. Defaults to PAYRAM_BASE_URL. The installer publishes on port 80 (http://localhost), not :8080.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['healthy', 'failedStage', 'findings', 'likelyCauses', 'nextSteps'], 'properties': {'healthy': {'type': 'boolean'}, 'findings': {'type': 'array', 'items': {'type': 'object', 'required': ['check', 'ok', 'detail'], 'properties': {'ok': {'type': 'boolean'}, 'check': {'type': 'string'}, 'detail': {'type': 'string'}}, 'additionalProperties': False}}, 'nextSteps': {'type': 'array', 'items': {'type': 'string'}}, 'failedStage': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'First failing stage: reachability | api-key | jwt | readiness; null when healthy'}, 'likelyCauses': {'type': 'array', 'items': {'type': 'object', 'required': ['likelihood', 'cause', 'fix'], 'properties': {'fix': {'type': 'string', 'description': 'The exact command or action that resolves it'}, 'cause': {'type': 'string'}, 'likelihood': {'type': 'string', 'description': 'Rough probability, e.g. "80%"'}}, 'additionalProperties': False}, 'description': 'Ranked causes for the first failing stage'}}, 'additionalProperties': False}
prepare_payram_test
Payram Test Readiness Checklist
Confirm hosting, credentials, and environment variables before generating demo apps.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'sections'], 'properties': {'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'sections': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'markdown', 'sources'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'markdown': {'type': 'string'}}, 'additionalProperties': False}}, 'description': {'type': 'string'}}, 'additionalProperties': False}
restart_payram_worker
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 → 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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'all': {'type': 'boolean', 'description': 'Restart ALL workers. Use only when multiple chains are unhealthy.'}, 'worker': {'type': 'string', 'minLength': 1, 'description': "Worker to restart: a chain code ('BASE', 'ETH', 'BTC', 'TRX', 'POLYGON' → restarts that chain's listener) or a full worker name ('base-listener'). Omit when using all=true."}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['restarted', 'message'], 'properties': {'message': {'type': 'string'}, 'restarted': {'type': 'string'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['language', 'framework'], 'properties': {'appName': {'type': 'string', 'minLength': 1, 'description': 'Name for the generated application. If not provided, defaults to payram-{framework}-starter'}, 'language': {'enum': ['node', 'python', 'php', 'go', 'java'], 'type': 'string', 'description': 'Programming language for the application (node for JavaScript/TypeScript)'}, 'framework': {'enum': ['express', 'nextjs', 'fastapi', 'laravel', 'gin', 'spring-boot'], 'type': 'string', 'description': 'Web framework to use for scaffolding the application'}, 'includeWebhooks': {'type': 'boolean', 'default': True, 'description': 'Whether to include webhook handler code in the scaffolded application'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['appName', 'language', 'framework', 'instructions', 'files'], 'properties': {'files': {'type': 'array', 'items': {'type': 'object', 'required': ['path', 'description', 'contents'], 'properties': {'path': {'type': 'string'}, 'contents': {'type': 'string'}, 'description': {'type': 'string'}}, 'additionalProperties': False}}, 'appName': {'type': 'string'}, 'language': {'type': 'string'}, 'framework': {'type': 'string'}, 'instructions': {'type': 'string'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Number of results per page. Defaults to 50.'}, 'query': {'type': 'string', 'description': 'Free-text search: tx hash, email, reference ID, customer ID, or invoice ID.'}, 'dateTo': {'type': 'string', 'description': 'End date filter (ISO 8601, e.g. 2024-12-31T23:59:59Z).'}, 'offset': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'Pagination offset. Defaults to 0.'}, 'sortBy': {'type': 'string', 'description': 'Sort field. Valid: created_at, updated_at, payment_status, currency, network, block_id, from_address, to_address, invoice_id, reference_id, customer_id, email, created_by.'}, 'network': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Filter by blockchain network (e.g. BTC, ETH, TRX, BASE, POLYGON).'}, 'currency': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Filter by currency code (e.g. USDC, USDT, BTC, ETH, TRX, CBBTC).'}, 'dateFrom': {'type': 'string', 'description': 'Start date filter (ISO 8601, e.g. 2024-01-01T00:00:00Z).'}, 'createdBy': {'type': 'array', 'items': {'enum': ['user', 'system'], 'type': 'string'}, 'description': 'Filter by creator type.'}, 'paymentStatus': {'type': 'array', 'items': {'enum': ['OPEN', 'FILLED', 'PARTIALLY_FILLED', 'OVER_FILLED', 'CANCELLED', 'CONFIRMING', 'DEPOSIT_RECEIVED', 'UNDEFINED'], 'type': 'string'}, 'description': 'Filter by payment status (FILLED = completed).'}, 'sortDirection': {'enum': ['ASC', 'DESC'], 'type': 'string', 'description': 'Sort direction. Defaults to DESC.'}, 'webhookStatus': {'type': 'array', 'items': {'enum': ['received', 'pending', 'failed', 'waiting_for_approval', 'discarded'], 'type': 'string'}, 'description': 'Filter by webhook delivery status.'}, 'externalPlatformId': {'type': 'string', 'description': 'Optional. Auto-discovered from your account if omitted.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['payments', 'totalCount', 'showing', 'limit', 'offset'], 'properties': {'limit': {'type': 'number'}, 'offset': {'type': 'number'}, 'showing': {'type': 'number'}, 'payments': {'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, 'totalCount': {'type': 'number'}}, 'additionalProperties': False}
snippet_express_payment_route
Express create-payment route snippet
Returns an Express router that posts to Payram's /api/v1/payment endpoint.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['nextjs', 'express', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
snippet_fastapi_payment_route
FastAPI create-payment route snippet
Returns a FastAPI handler that calls Payram's create-payment HTTP API.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['nextjs', 'express', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['nextjs', 'express', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
snippet_laravel_payment_route
Laravel create-payment route snippet
Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['nextjs', 'express', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['nextjs', 'express', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
snippet_spring_payment_controller
Spring Boot create-payment controller snippet
Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'snippet', 'meta'], 'properties': {'meta': {'type': 'object', 'required': ['language', 'framework'], 'properties': {'language': {'enum': ['typescript', 'javascript', 'python', 'go', 'php', 'java'], 'type': 'string'}, 'framework': {'enum': ['nextjs', 'express', 'fastapi', 'gin', 'laravel', 'spring-boot', 'generic-http'], 'type': 'string'}, 'description': {'type': 'string'}, 'filenameSuggestion': {'type': 'string'}}, 'additionalProperties': False}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'snippet': {'type': 'string'}}, 'additionalProperties': False}
suggest_file_structure
Suggest Payram File Structure
Suggests a recommended backend folder/file structure for integrating Payram.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['title', 'root'], 'properties': {'root': {'$ref': '#/definitions/__schema0'}, 'notes': {'type': 'string'}, 'title': {'type': 'string'}, 'description': {'type': 'string'}}, 'definitions': {'__schema0': {'type': 'object', 'required': ['path', 'type'], 'properties': {'path': {'type': 'string'}, 'type': {'enum': ['file', 'folder'], 'type': 'string'}, 'children': {'type': 'array', 'items': {'$ref': '#/definitions/__schema0'}}, 'description': {'type': 'string'}}, 'additionalProperties': False}}, 'additionalProperties': False}
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.
Input schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'apiKey': {'type': 'string', 'minLength': 1, 'description': 'Your Payram API key from the dashboard. If not provided, uses PAYRAM_API_KEY from environment.'}, 'baseUrl': {'type': 'string', 'format': 'uri', 'description': 'The base URL of your Payram server (e.g., https://your-server.example). If not provided, uses PAYRAM_BASE_URL from environment.'}}, 'additionalProperties': False}
Output schema 
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['ok', 'statusCode', 'baseUrl'], 'properties': {'ok': {'type': 'boolean'}, 'baseUrl': {'type': 'string'}, 'statusCode': {'anyOf': [{'type': 'integer', 'maximum': 599, 'minimum': 100}, {'type': 'null'}]}, 'errorMessage': {'type': 'string'}, 'payramVersion': {'type': 'string'}}, 'additionalProperties': False}
History

Recent tool changes

Added
check_payment_readiness
Sept. 17, 2026, 12:45 p.m.
Added
restart_payram_worker
Sept. 17, 2026, 12:45 p.m.
Added
check_node_sync
Sept. 17, 2026, 12:45 p.m.
Added
create_payment_link
Sept. 17, 2026, 12:45 p.m.
Added
list_recipients
Sept. 17, 2026, 12:45 p.m.
Added
list_currencies
Sept. 17, 2026, 12:45 p.m.
Added
get_daily_volume
Sept. 17, 2026, 12:45 p.m.
Added
get_unswept_balances
Sept. 17, 2026, 12:45 p.m.
Added
search_payments
Sept. 17, 2026, 12:45 p.m.
Added
lookup_payment
Sept. 17, 2026, 12:45 p.m.
Added
get_payment_summary
Sept. 17, 2026, 12:45 p.m.
Added
list_platforms
Sept. 17, 2026, 12:45 p.m.
Added
scaffold_payram_app
Sept. 17, 2026, 12:45 p.m.
Added
onboard_agent_setup
Sept. 17, 2026, 12:45 p.m.
Added
get_agent_setup_flow
Sept. 17, 2026, 12:45 p.m.
Added
suggest_file_structure
Sept. 17, 2026, 12:45 p.m.
Added
generate_setup_checklist
Sept. 17, 2026, 12:45 p.m.
Added
generate_env_template
Sept. 17, 2026, 12:45 p.m.
Added
list_payram_docs
Sept. 17, 2026, 12:45 p.m.
Added
get_payram_doc_by_id
Sept. 17, 2026, 12:45 p.m.
Added
prepare_payram_test
Sept. 17, 2026, 12:45 p.m.
Added
get_referral_dashboard_guide
Sept. 17, 2026, 12:45 p.m.
Added
explain_referral_flow
Sept. 17, 2026, 12:45 p.m.
Added
explain_referrals_basics
Sept. 17, 2026, 12:45 p.m.
Added
explain_payram_concepts
Sept. 17, 2026, 12:45 p.m.
Added
explain_payment_flow
Sept. 17, 2026, 12:45 p.m.
Added
get_payram_links
Sept. 17, 2026, 12:45 p.m.
Added
explain_payram_basics
Sept. 17, 2026, 12:45 p.m.
Added
generate_topup_integration_snippet
Sept. 17, 2026, 12:45 p.m.
Added
assess_payram_project
Sept. 17, 2026, 12:45 p.m.
Discover

Similar MCP servers

AgentPay — Pay-per-call AI Microservices

io.github.ronaldanton/agentpay

Exposes pay-per-call microservices for research, translation, code review, security checks, web access, financial data, and other…

trading-mcp

com.ai-rook.agents/trading-mcp

Catalogs and quotes paid trading, AI, blockchain, developer, and escrow endpoints, and provides previews, escrow inspection, atte…

Agents Get Paid Kit — x402 MCP + Unlock ($49)

com.agentsgetpaidmore/agents-get-paid-kit

Sells an agent toolkit and provides paid x402 USDC services for web page unlocking and restricted CAPTCHA solving.

ACN Preflight

io.github.Abacore-net/acn-preflight

Checks GitHub bounty status, repository contribution readiness, and technical payment readiness for Base transactions.

micropay-test-suite

app.netlify.micropay-test-suite/micropay-test-suite

Tests agent x402 payment flows on the Base Sepolia cryptocurrency testnet.

SAP MCP Server

ai.oobeprotocol.sap.mcp/sap-mcp

Provides an MCP gateway connecting SAP-related tools with Solana, DeFi, decentralized identity, and x402 payments.

FortFi Treasury MCP

io.github.rebelArtists/fortfi-treasury-mcp

Provides policy-controlled crypto treasury operations across chains, including wallets, payments, token discovery, swaps, bridges…

DPX — Institutional Cross-Border Settlement

io.github.untitledfinancial/dpx

Provides compliance-gated cross-border crypto settlement, agent registration and spending mandates, stablecoin routing, ESG and s…