io.github.PayRam/payram-helper-mcp

Est-ce que io.github.PayRam/payram-helper-mcp est sûr ?

Au dernier audit MCP Hub, le serveur MCP « io.github.PayRam/payram-helper-mcp » est classé « Non encore testé ». Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur. Le verdict est réévalué en continu ; consultez la fiche pour l'état à jour.

Méthode : MCP Hub analyse la description de chaque outil (couche 1) et, pour le verdict fort, exécute le serveur dans une micro-VM isolée avec leurres et réseau bloqué (couche 2). On publie des noms et des compteurs, jamais le contenu brut renvoyé par un outil.

Les 52 outils

• assess_payram_project≈ 582 tokens

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

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "assess_payram_project", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"summary": "texte", "envStatus": {}, "frameworks": [], "detectedFiles": [], "packageManagers": [], "payramDependencies": [], "recommendedNextSteps": []}}

• check_node_sync≈ 582 tokens

  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.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "check_node_sync", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"chains": [], "issues": [], "healthy": true, "workers": [], "workersAvailable": true}}

• check_payment_readiness≈ 376 tokens

  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.

  Paramètres, retour & exemple (1)

  Paramètres

  • externalPlatformId · string · optionnel
    Project/platform ID to check currency enablement for (auto-resolved if omitted)

  Exemple d'appel

  {"name": "check_payment_readiness", "arguments": {"externalPlatformId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"chains": [], "allReady": true, "projectId": "texte", "readyChains": []}}

• create_payment_link≈ 351 tokens

  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}).

  Paramètres, retour & exemple (3)

  Paramètres

  • customerID · string · requis
    Your internal customer identifier (sent as customerID, required)
  • amountInUSD · number · requis
    Payment amount in USD (must be > 0)
  • customerEmail · string · requis
    Customer email (required — the backend validates it as a non-empty email)

  Exemple d'appel

  {"name": "create_payment_link", "arguments": {"customerID": "texte", "amountInUSD": 1, "customerEmail": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"url": "texte", "host": "texte", "reference_id": "texte"}}

• explain_payment_flow≈ 251 tokens

  Describe how payments move from customer initiation through settlement.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "explain_payment_flow", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• explain_payram_basics≈ 255 tokens

  Explain Payram's product pillars, architecture, payments, and payouts capabilities.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "explain_payram_basics", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• explain_payram_concepts≈ 251 tokens

  Glossary-backed explanation of Payram terminology and constraints.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "explain_payram_concepts", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• explain_referral_flow≈ 248 tokens

  Detail the referrer/referee lifecycle and required APIs.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "explain_referral_flow", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• explain_referrals_basics≈ 252 tokens

  Summarize how Payram referral campaigns are configured and managed.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "explain_referrals_basics", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• generate_env_template≈ 256 tokens

  Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "generate_env_template", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "variables": [], "envExample": "texte", "description": "texte"}}

• generate_mock_webhook_event≈ 354 tokens

  Generates a snippet to send mock Payram webhook events to your local endpoint for testing.

  Paramètres, retour & exemple (2)

  Paramètres

  • status · string · requis · OPEN | CANCELLED | FILLED | PARTIALLY_FILLED | OVER_FILLED | UNDEFINED
    Payment status to simulate in the mock webhook event
  • language · string · requis · curl | python | go | php | java
    Language/tool for the mock webhook request (curl for command-line testing)

  Exemple d'appel

  {"name": "generate_mock_webhook_event", "arguments": {"status": "OPEN", "language": "curl"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_payment_http_snippet≈ 284 tokens

  Generates a raw HTTP sample for creating a Payram payment in the requested language.

  Paramètres, retour & exemple (1)

  Paramètres

  • language · string · requis · python | go | php | java
    Programming language for the HTTP payment creation snippet

  Exemple d'appel

  {"name": "generate_payment_http_snippet", "arguments": {"language": "python"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_payment_route_snippet≈ 288 tokens

  Generates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment.

  Paramètres, retour & exemple (1)

  Paramètres

  • framework · string · requis · express | nextjs
    Web framework for the payment route handler (Express.js or Next.js)

  Exemple d'appel

  {"name": "generate_payment_route_snippet", "arguments": {"framework": "express"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_payment_sdk_snippet≈ 294 tokens

  Generates backend code using the official Payram JS/TS SDK to create a payment.

  Paramètres, retour & exemple (1)

  Paramètres

  • framework · string · requis · generic-http | express | nextjs
    Target framework for the SDK payment snippet. generic-http provides a framework-agnostic example.

  Exemple d'appel

  {"name": "generate_payment_sdk_snippet", "arguments": {"framework": "generic-http"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_payment_status_snippet≈ 279 tokens

  Generates backend code to query the status of a Payram payment.

  Paramètres, retour & exemple (1)

  Paramètres

  • style · string · requis · sdk | http
    Style of code snippet: sdk uses the Payram SDK, http uses raw HTTP requests

  Exemple d'appel

  {"name": "generate_payment_status_snippet", "arguments": {"style": "sdk"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_payout_recipient_flow_snippet≈ 266 tokens

  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.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "generate_payout_recipient_flow_snippet", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_payout_sdk_snippet≈ 260 tokens

  Generates a backend code snippet for creating a payout using the Payram JS/TS SDK.

  Paramètres, retour & exemple (1)

  Paramètres

  • framework · string · requis · generic-http
    Target framework for the payout SDK snippet

  Exemple d'appel

  {"name": "generate_payout_sdk_snippet", "arguments": {"framework": "generic-http"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_payout_status_snippet≈ 224 tokens

  Generates backend code to query the status of a payout using the Payram SDK.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "generate_payout_status_snippet", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_referral_route_snippet≈ 275 tokens

  Generates a backend route such as /api/referrals/create for logging referral events.

  Paramètres, retour & exemple (1)

  Paramètres

  • framework · string · requis · express | nextjs
    Web framework for the referral route handler (Express.js or Next.js)

  Exemple d'appel

  {"name": "generate_referral_route_snippet", "arguments": {"framework": "express"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_referral_sdk_snippet≈ 269 tokens

  Generates a backend route or service snippet to create a referral event using the Payram SDK.

  Paramètres, retour & exemple (1)

  Paramètres

  • framework · string · requis · generic-http
    Target framework for the referral SDK snippet

  Exemple d'appel

  {"name": "generate_referral_sdk_snippet", "arguments": {"framework": "generic-http"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_referral_status_snippet≈ 272 tokens

  Generates code to fetch referral progress, rewards, or status.

  Paramètres, retour & exemple (1)

  Paramètres

  • style · string · requis · sdk | backend-only
    Style of code snippet: sdk uses the Payram SDK, backend-only shows direct API calls

  Exemple d'appel

  {"name": "generate_referral_status_snippet", "arguments": {"style": "sdk"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_referral_validation_snippet≈ 230 tokens

  Generates a snippet to validate referral IDs, statuses, and eligibility.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "generate_referral_validation_snippet", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_setup_checklist≈ 231 tokens

  Returns a step-by-step checklist of everything a merchant must configure to start using Payram.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "generate_setup_checklist", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"items": [], "notes": "texte", "title": "texte", "description": "texte"}}

• generate_topup_integration_snippet≈ 339 tokens

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

  Paramètres, retour & exemple (2)

  Paramètres

  • part · string · optionnel · schema | webhook | settle | all
    Which piece to emit: 'schema' (ledger DDL), 'webhook' (cumulative-credit handler), 'settle' (atomic invoice debit), or 'all'.
  • framework · string · optionnel · express | fastapi
    Server framework for the webhook handler + settle function.

  Exemple d'appel

  {"name": "generate_topup_integration_snippet", "arguments": {"part": "schema", "framework": "express"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_webhook_event_router≈ 255 tokens

  Generates a backend event router that dispatches Payram webhook events to domain handlers.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "generate_webhook_event_router", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• generate_webhook_handler≈ 296 tokens

  Generates backend code to handle Payram webhook HTTP requests.

  Paramètres, retour & exemple (1)

  Paramètres

  • framework · string · requis · express | nextjs | fastapi | gin | laravel | spring-boot
    Web framework for the webhook handler code

  Exemple d'appel

  {"name": "generate_webhook_handler", "arguments": {"framework": "express"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• get_agent_setup_flow≈ 206 tokens

  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.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "get_agent_setup_flow", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"title": "texte", "markdown": "texte", "description": "texte"}}

• get_daily_volume≈ 352 tokens

  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.

  Paramètres, retour & exemple (2)

  Paramètres

  • date · string · optionnel
    Date in YYYY-MM-DD format. Defaults to today (UTC).
  • externalPlatformId · string · optionnel
    Optional. Auto-discovered from your account if omitted.

  Exemple d'appel

  {"name": "get_daily_volume", "arguments": {"date": "texte", "externalPlatformId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"date": "texte", "byNetwork": [], "byCurrency": [], "totalPayments": 1, "totalVolumeUSD": 1}}

• get_payment_summary≈ 198 tokens

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

  Paramètres, retour & exemple (1)

  Paramètres

  • externalPlatformId · string · optionnel
    Optional. Auto-discovered from your account if omitted.

  Exemple d'appel

  {"name": "get_payment_summary", "arguments": {"externalPlatformId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"openCount": 1, "totalCount": 1, "closedCount": 1, "cancelledCount": 1}}

• get_payram_doc_by_id≈ 159 tokens

  Returns the markdown for a Payram doc given its id, e.g. "features/payouts".

  Paramètres, retour & exemple (1)

  Paramètres

  • id · string · requis

  Exemple d'appel

  {"name": "get_payram_doc_by_id", "arguments": {"id": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"id": "texte", "url": "texte", "path": "texte", "markdown": "texte"}}

• get_payram_links≈ 248 tokens

  Surface official documentation, website, and community links.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "get_payram_links", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• get_referral_dashboard_guide≈ 253 tokens

  Explain how to embed and manage the referral dashboard experience.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "get_referral_dashboard_guide", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• get_unswept_balances≈ 528 tokens

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

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "get_unswept_balances", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"balances": [], "totalWallets": 1}}

• list_currencies≈ 257 tokens

  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.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "list_currencies", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"count": 1, "currencies": []}}

• list_payram_docs≈ 154 tokens

  Lists the available Payram doc ids relative to docs/payram-docs-live. Optionally scope by a prefix such as "features".

  Paramètres, retour & exemple (1)

  Paramètres

  • prefix · string · optionnel

  Exemple d'appel

  {"name": "list_payram_docs", "arguments": {"prefix": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"docs": [], "count": 1, "prefix": "texte"}}

• list_platforms≈ 205 tokens

  Lists all external platforms (projects) for the authenticated user. Use this to discover your platform ID, which other tools auto-resolve if omitted.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "list_platforms", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"count": 1, "platforms": []}}

• list_recipients≈ 280 tokens

  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.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "list_recipients", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"count": 1, "recipients": []}}

• lookup_payment≈ 481 tokens

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

  Paramètres, retour & exemple (2)

  Paramètres

  • query · string · requis
    Search query: transaction hash, email address, reference ID (UUID), customer ID, or invoice ID. The backend auto-detects the query type.
  • externalPlatformId · string · optionnel
    Optional. Auto-discovered from your account if omitted.

  Exemple d'appel

  {"name": "lookup_payment", "arguments": {"query": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"payments": [], "totalCount": 1}}

• onboard_agent_setup≈ 153 tokens

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

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "onboard_agent_setup", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"title": "texte", "markdown": "texte", "description": "texte"}}

• payram_doctor≈ 498 tokens

  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.

  Paramètres, retour & exemple (2)

  Paramètres

  • apiKey · string · optionnel
    Merchant API key (per-project). Defaults to PAYRAM_API_KEY. Obtain headlessly: ./setup_payram_agents.sh ensure-api-key
  • baseUrl · string · optionnel
    PayRam server base URL. Defaults to PAYRAM_BASE_URL. The installer publishes on port 80 (http://localhost), not :8080.

  Exemple d'appel

  {"name": "payram_doctor", "arguments": {"apiKey": "texte", "baseUrl": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"healthy": true, "findings": [], "nextSteps": [], "failedStage": "texte", "likelyCauses": []}}

• prepare_payram_test≈ 257 tokens

  Confirm hosting, credentials, and environment variables before generating demo apps.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "prepare_payram_test", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"notes": "texte", "title": "texte", "sections": [], "description": "texte"}}

• restart_payram_worker≈ 308 tokens

  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.

  Paramètres, retour & exemple (2)

  Paramètres

  • all · boolean · optionnel
    Restart ALL workers. Use only when multiple chains are unhealthy.
  • worker · string · optionnel
    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.

  Exemple d'appel

  {"name": "restart_payram_worker", "arguments": {"all": true, "worker": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"message": "texte", "restarted": "texte"}}

• scaffold_payram_app≈ 415 tokens

  Generates a minimal full-stack app skeleton with Payram payments and payouts routes (and a simple UI) for a chosen language and framework.

  Paramètres, retour & exemple (4)

  Paramètres

  • appName · string · optionnel
    Name for the generated application. If not provided, defaults to payram-{framework}-starter
  • language · string · requis · node | python | php | go | java
    Programming language for the application (node for JavaScript/TypeScript)
  • framework · string · requis · express | nextjs | fastapi | laravel | gin | spring-boot
    Web framework to use for scaffolding the application
  • includeWebhooks · boolean · optionnel
    Whether to include webhook handler code in the scaffolded application

  Exemple d'appel

  {"name": "scaffold_payram_app", "arguments": {"language": "node", "framework": "express"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"files": [], "appName": "texte", "language": "texte", "framework": "texte", "instructions": "texte"}}

• search_payments≈ 682 tokens

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

  Paramètres, retour & exemple (13)

  Paramètres

  • limit · integer · optionnel
    Number of results per page. Defaults to 50.
  • query · string · optionnel
    Free-text search: tx hash, email, reference ID, customer ID, or invoice ID.
  • dateTo · string · optionnel
    End date filter (ISO 8601, e.g. 2024-12-31T23:59:59Z).
  • offset · integer · optionnel
    Pagination offset. Defaults to 0.
  • sortBy · string · optionnel
    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 · array · optionnel
    Filter by blockchain network (e.g. BTC, ETH, TRX, BASE, POLYGON).
  • currency · array · optionnel
    Filter by currency code (e.g. USDC, USDT, BTC, ETH, TRX, CBBTC).
  • dateFrom · string · optionnel
    Start date filter (ISO 8601, e.g. 2024-01-01T00:00:00Z).
  • createdBy · array · optionnel
    Filter by creator type.
  • paymentStatus · array · optionnel
    Filter by payment status (FILLED = completed).
  • sortDirection · string · optionnel · ASC | DESC
    Sort direction. Defaults to DESC.
  • webhookStatus · array · optionnel
    Filter by webhook delivery status.
  • externalPlatformId · string · optionnel
    Optional. Auto-discovered from your account if omitted.

  Exemple d'appel

  {"name": "search_payments", "arguments": {"limit": 1, "query": "texte", "dateTo": "texte", "offset": 1, "sortBy": "texte", "network": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"limit": 1, "offset": 1, "showing": 1, "payments": [], "totalCount": 1}}

• snippet_express_payment_route≈ 251 tokens

  Returns an Express router that posts to Payram's /api/v1/payment endpoint.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "snippet_express_payment_route", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• snippet_fastapi_payment_route≈ 250 tokens

  Returns a FastAPI handler that calls Payram's create-payment HTTP API.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "snippet_fastapi_payment_route", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• snippet_go_payment_handler≈ 253 tokens

  Returns a Gin handler that proxies /api/pay/create to Payram's create-payment API.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "snippet_go_payment_handler", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• snippet_laravel_payment_route≈ 252 tokens

  Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "snippet_laravel_payment_route", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• snippet_nextjs_payment_route≈ 253 tokens

  Returns a Next.js App Router API route that calls Payram's create-payment HTTP API.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "snippet_nextjs_payment_route", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• snippet_spring_payment_controller≈ 256 tokens

  Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "snippet_spring_payment_controller", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"meta": {}, "notes": "texte", "title": "texte", "snippet": "texte"}}

• suggest_file_structure≈ 234 tokens

  Suggests a recommended backend folder/file structure for integrating Payram.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "suggest_file_structure", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"root": "texte", "notes": "texte", "title": "texte", "description": "texte"}}

• test_payram_connection≈ 288 tokens

  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.

  Paramètres, retour & exemple (2)

  Paramètres

  • apiKey · string · optionnel
    Your Payram API key from the dashboard. If not provided, uses PAYRAM_API_KEY from environment.
  • baseUrl · string · optionnel
    The base URL of your Payram server (e.g., https://your-server.example). If not provided, uses PAYRAM_BASE_URL from environment.

  Exemple d'appel

  {"name": "test_payram_connection", "arguments": {"apiKey": "texte", "baseUrl": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}], "structuredContent": {"ok": true, "baseUrl": "texte", "statusCode": "texte", "errorMessage": "texte", "payramVersion": "texte"}}

C'est votre serveur ?

Revendiquez-le sur l'espace créateur (preuve GitHub, domaine ou npm) pour afficher le badge « propriétaire vérifié » et lancer un pentest comportemental à la demande afin d'obtenir le badge « Vérifié ».

Créer un compte / revendiquer →

Source

https://mcp.payram.com/