PayRam
Install, configure, operate and integrate self-hosted PayRam crypto payment gateways.
¿Debería usar esto?
Calidad y seguridad
B
Hallazgos (18)
- LOWTool 'suggest_file_structure' description lacks action verben suggest_file_structure
- LOWTool 'snippet_express_payment_route' description lacks action verben snippet_express_payment_route
- LOWTool 'snippet_laravel_payment_route' description lacks action verben snippet_laravel_payment_route
- LOWTool 'explain_payram_basics' description lacks action verben explain_payram_basics
- LOWTool 'get_payram_links' description lacks action verben get_payram_links
- LOWTool 'explain_referral_flow' description lacks action verben explain_referral_flow
- LOWTool 'get_payram_doc_by_id' description lacks action verben get_payram_doc_by_id
- LOWTool 'generate_payment_status_snippet' name length outside 3-30 rangeen generate_payment_status_snippet
- LOWTool 'snippet_spring_payment_controller' name length outside 3-30 rangeen snippet_spring_payment_controller
- LOWTool 'generate_payout_recipient_flow_snippet' name length outside 3-30 rangeen generate_payout_recipient_flow_snippet
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
~11,798Tokens (definiciones de herramientas)
~2.5 KBTamaño de respuesta típico
Impacto significativo en la atención (9.22% del contexto de 128k)
Este es el número aproximado de tokens que se consumen cada vez que las herramientas del servidor se cargan en el contexto de un modelo. Los recuentos más altos reducen la atención disponible para otras tareas.
Instalar
Instalación con un clic
Agrega esto a tu archivo `claude_desktop_config.json`:
{
"mcpServers": {
"mcp": {
"url": "https://mcp.payram.com/mcp"
}
}
}Puntos de conexión remotos
https://mcp.payram.com/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (42)
🟢 Solo lectura🟡 Escritura🔴 Eliminación⚪ Desconocido
🟢payram_setup_plan(path, network, domain, ssl, role, ...)
Start here to install PayRam on a VPS. Returns an ordered, personalised plan — prepare server → install → claim admin + set public URL → wallets (incl. Smart Bridge review) → API key + first payment link → hardening → store/app integration — with who runs each step (agent shell vs human/dashboard), exact commands, what success looks like, and hard stops that need the human (cold wallet, mainnet spend, root-only settings). Pass stage to resume mid-way.
Esquema de entrada
{
"type": "object",
"properties": {
"path": {
"default": "agent",
"description": "agent = headless CLI after a one-time interactive install; human = installer + web dashboard",
"type": "string",
"enum": [
"agent",
"human"
]
},
"network": {
"default": "testnet",
"description": "testnet = free test coins (recommended first); mainnet = real money",
"type": "string",
"enum": [
"testnet",
"mainnet"
]
},
"domain": {
"description": "Public hostname for the gateway, e.g. pay.example.com. Omit if you only have an IP for now.",
"type": "string",
"pattern": "^(?=.{1,253}$)([a-z0-9-]+\\.)+[a-z]{2,}$"
},
"ssl": {
"description": "letsencrypt (needs domain), own_certificate, proxy (Cloudflare/your own reverse proxy terminates TLS), none. Default: letsencrypt with a domain, none without.",
"type": "string",
"enum": [
"letsencrypt",
"own_certificate",
"proxy",
"none"
]
},
"role": {
"default": "merchant",
"description": "merchant: Take payments for your own business (default). operator: Run PayRam as a platform for other merchants and earn a fee on their volume. Must be chosen before the first project; the role locks once role-specific data exists.",
"type": "string",
"enum": [
"merchant",
"operator"
]
},
"wallet": {
"default": "usdc_base",
"description": "First deposit wallet: usdc_base (smart-contract wallet on Base, needs a little gas), btc (xpub, no gas), or both",
"type": "string",
"enum": [
"usdc_base",
"btc",
"both"
]
},
"stage": {
"default": "fresh",
"description": "Where you are now; the plan starts from the next step",
"type": "string",
"enum": [
"fresh",
"installed",
"account_created",
"wallet_ready",
"payment_link_created"
]
},
"integration": {
"default": "none",
"description": "What will take payments once the gateway is up",
"type": "string",
"enum": [
"none",
"website",
"shopify",
"woocommerce"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"summary": {
"type": "string"
},
"inputs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"phases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"executor": {
"type": "string",
"enum": [
"agent_shell",
"agent_http",
"human",
"human_dashboard"
]
},
"commands": {
"type": "string"
},
"expect": {
"type": "string"
},
"gate": {
"description": "Why the agent must stop and get the human here",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"title",
"executor"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"steps"
],
"additionalProperties": false
}
},
"humanDecisions": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"nextTools": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"summary",
"inputs",
"phases",
"humanDecisions",
"warnings",
"nextTools"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢payram_doctor(baseUrl, apiKey)
Read-only diagnosis of a PayRam server by its public URL — works from the hosted MCP without credentials: reachability, health, TLS certificate, installed vs latest version, worker states. Optionally validates an API key without creating anything. Returns ranked likely causes and exact fixes for the first failing stage. Run this first when anything PayRam-related fails.
Esquema de entrada
{
"type": "object",
"properties": {
"baseUrl": {
"description": "Public URL of the PayRam server, same origin as the dashboard (e.g. https://pay.example.com). No :8080. Required on the hosted MCP.",
"type": "string"
},
"apiKey": {
"description": "Optional project API key to validate (never creates anything). Passing it puts the key in this conversation; prefer running payram_ops_playbook \"connect\" locally.",
"type": "string",
"minLength": 1
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"baseUrl": {
"type": [
"string",
"null"
]
},
"healthy": {
"type": "boolean"
},
"failedStage": {
"description": "First failing stage, null when healthy",
"type": [
"string",
"null"
]
},
"version": {
"type": [
"string",
"null"
]
},
"latestVersion": {
"type": [
"string",
"null"
]
},
"findings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"check": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"detail": {
"type": "string"
}
},
"required": [
"check",
"ok",
"detail"
],
"additionalProperties": false
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"likelyCauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"likelihood": {
"type": "string",
"description": "Rough probability, e.g. \"60%\""
},
"cause": {
"type": "string"
},
"fix": {
"type": "string",
"description": "The exact command or action that resolves it"
}
},
"required": [
"likelihood",
"cause",
"fix"
],
"additionalProperties": false
},
"description": "Ranked causes for the first failing stage"
},
"nextSteps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"baseUrl",
"healthy",
"failedStage",
"version",
"latestVersion",
"findings",
"warnings",
"likelyCauses",
"nextSteps"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢payram_runbook(task)
Step-by-step procedures for changes to a running PayRam, each step marked agent vs human with hard stops: set_site_url, change_domain, ssl_setup, ssl_renewal_fix, firewall_ports, upgrade, backup, restore, add_chain, smart_bridge, mainnet_cutover, operator_setup, rotate_api_key, reset_test_install, shopify_connector, woocommerce_plugin, secure_analytics_mcp. Omit task to list them.
Esquema de entrada
{
"type": "object",
"properties": {
"task": {
"description": "Which runbook. Omit to list all.",
"type": "string",
"enum": [
"set_site_url",
"change_domain",
"ssl_setup",
"ssl_renewal_fix",
"firewall_ports",
"upgrade",
"backup",
"restore",
"add_chain",
"smart_bridge",
"mainnet_cutover",
"operator_setup",
"rotate_api_key",
"reset_test_install",
"shopify_connector",
"woocommerce_plugin",
"secure_analytics_mcp"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"task": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"task",
"title"
],
"additionalProperties": false
}
},
"runbook": {
"type": "object",
"properties": {
"task": {
"type": "string",
"enum": [
"set_site_url",
"change_domain",
"ssl_setup",
"ssl_renewal_fix",
"firewall_ports",
"upgrade",
"backup",
"restore",
"add_chain",
"smart_bridge",
"mainnet_cutover",
"operator_setup",
"rotate_api_key",
"reset_test_install",
"shopify_connector",
"woocommerce_plugin",
"secure_analytics_mcp"
]
},
"title": {
"type": "string"
},
"when": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"who": {
"type": "string",
"enum": [
"agent_shell",
"human",
"human_dashboard"
]
},
"do": {
"type": "string"
},
"commands": {
"type": "string"
},
"gate": {
"type": "string"
}
},
"required": [
"who",
"do"
],
"additionalProperties": false
}
},
"verify": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"task",
"title",
"when",
"steps",
"verify",
"warnings"
],
"additionalProperties": false
}
},
"required": [
"tasks"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢payram_ops_playbook(task)
Exact, copy-paste recipes for day-2 operations and troubleshooting that YOU run against the merchant's PayRam API with credentials that stay on your machine: which endpoint, which credential (public / dashboard JWT / project API key), a curl+jq command, how to read the answer, and what not to do. Start with "connect". Tasks: connect, health, version_check, workers, restart_worker, node_sync, site_url, payment_options, unswept_funds, payments_today, payment_lookup, stuck_payment, create_payment_link, payouts, webhooks, logs, daily_check. Omit task to list them.
Esquema de entrada
{
"type": "object",
"properties": {
"task": {
"description": "Which recipe. Omit to get the index of tasks.",
"type": "string",
"enum": [
"connect",
"health",
"version_check",
"workers",
"restart_worker",
"node_sync",
"site_url",
"payment_options",
"unswept_funds",
"payments_today",
"payment_lookup",
"stuck_payment",
"create_payment_link",
"payouts",
"webhooks",
"logs",
"daily_check"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"task": {
"type": "string"
},
"title": {
"type": "string"
},
"auth": {
"type": "string"
},
"safety": {
"type": "string"
}
},
"required": [
"task",
"title",
"auth",
"safety"
],
"additionalProperties": false
}
},
"recipe": {
"type": "object",
"properties": {
"task": {
"type": "string",
"enum": [
"connect",
"health",
"version_check",
"workers",
"restart_worker",
"node_sync",
"site_url",
"payment_options",
"unswept_funds",
"payments_today",
"payment_lookup",
"stuck_payment",
"create_payment_link",
"payouts",
"webhooks",
"logs",
"daily_check"
]
},
"title": {
"type": "string"
},
"when": {
"type": "string"
},
"auth": {
"type": "string",
"enum": [
"none",
"jwt",
"jwt_root",
"api_key",
"server_shell"
]
},
"safety": {
"type": "string",
"enum": [
"read",
"write_needs_confirmation"
]
},
"commands": {
"type": "string"
},
"interpret": {
"type": "array",
"items": {
"type": "string"
}
},
"pitfalls": {
"type": "array",
"items": {
"type": "string"
}
},
"next": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"task",
"title",
"when",
"auth",
"safety",
"commands",
"interpret",
"pitfalls",
"next"
],
"additionalProperties": false
}
},
"required": [
"tasks"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢test_payram_connection(baseUrl, apiKey)
Read-only check that a PayRam server is reachable and healthy and, if an API key is supplied, that the key is accepted. Never creates payments. For a full diagnosis use payram_doctor.
Esquema de entrada
{
"type": "object",
"properties": {
"baseUrl": {
"description": "PayRam URL, same origin as the dashboard (e.g. https://pay.example.com). Defaults to PAYRAM_BASE_URL in local mode.",
"type": "string"
},
"apiKey": {
"description": "Optional project API key to validate (nothing is created). Passing it exposes the key in this conversation.",
"type": "string",
"minLength": 1
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"baseUrl": {
"type": "string"
},
"payramVersion": {
"type": "string"
},
"keyChecked": {
"type": "boolean"
},
"errorMessage": {
"type": "string"
}
},
"required": [
"ok",
"baseUrl",
"keyChecked"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_env_template
Creates a .env template for configuring a merchant backend to talk to a self-hosted Payram server.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"envExample": {
"type": "string"
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"required": {
"type": "boolean"
},
"description": {
"type": "string"
},
"example": {
"type": "string"
},
"defaultValue": {
"type": "string"
},
"docsRefs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"key",
"required",
"description"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"envExample",
"variables"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_setup_checklist
Returns a step-by-step checklist of everything a merchant must configure to start using Payram.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"docsRefs": {
"type": "array",
"items": {
"type": "string"
}
},
"optional": {
"type": "boolean"
}
},
"required": [
"id",
"label",
"description"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"items"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢suggest_file_structure
Suggests a recommended backend folder/file structure for integrating Payram.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"root": {
"$ref": "#/$defs/__schema0"
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"root"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"file",
"folder"
]
},
"description": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"path",
"type"
],
"additionalProperties": false
}
}
}🟢get_agent_setup_flow
Returns the canonical PayRam headless-agent guide (payram-scripts PAYRAM_HEADLESS_AGENT.md): agent CLI commands, env vars, merchant vs operator mode, wallet flows, adding chains, troubleshooting. Long (~11k tokens). For a short personalised plan use payram_setup_plan.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"required": [
"title",
"markdown"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢onboard_agent_setup
Quick start for an agent installing PayRam on a VPS: returns the default headless plan (testnet, USDC on Base) with exact commands and the human hand-offs. Same as payram_setup_plan with defaults; call that tool to personalise (domain, mainnet, BTC, operator, Shopify/WooCommerce).
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"required": [
"title",
"markdown"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_payment_sdk_snippet(framework)
Generates backend code using the official Payram JS/TS SDK to create a payment.
Esquema de entrada
{
"type": "object",
"properties": {
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
],
"description": "Target framework for the SDK payment snippet. generic-http provides a framework-agnostic example."
}
},
"required": [
"framework"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_payment_http_snippet(language)
Generates a raw HTTP sample for creating a Payram payment in the requested language.
Esquema de entrada
{
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"python",
"go",
"php",
"java"
],
"description": "Programming language for the HTTP payment creation snippet"
}
},
"required": [
"language"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_payment_status_snippet(style)
Generates backend code to query the status of a Payram payment.
Esquema de entrada
{
"type": "object",
"properties": {
"style": {
"type": "string",
"enum": [
"sdk",
"http"
],
"description": "Style of code snippet: sdk uses the Payram SDK, http uses raw HTTP requests"
}
},
"required": [
"style"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_payment_route_snippet(framework)
Generates a ready-to-use backend endpoint (e.g., /api/pay/create) that creates a Payram payment.
Esquema de entrada
{
"type": "object",
"properties": {
"framework": {
"type": "string",
"enum": [
"express",
"nextjs"
],
"description": "Web framework for the payment route handler (Express.js or Next.js)"
}
},
"required": [
"framework"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢snippet_nextjs_payment_route
Returns a Next.js App Router API route that calls Payram's create-payment HTTP API.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"nextjs",
"express",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢snippet_express_payment_route
Returns an Express router that posts to Payram's /api/v1/payment endpoint.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"nextjs",
"express",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢snippet_fastapi_payment_route
Returns a FastAPI handler that calls Payram's create-payment HTTP API.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"nextjs",
"express",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢snippet_laravel_payment_route
Returns a Laravel controller that posts to Payram's /api/v1/payment endpoint.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"nextjs",
"express",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢snippet_go_payment_handler
Returns a Gin handler that proxies /api/pay/create to Payram's create-payment API.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"nextjs",
"express",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢snippet_spring_payment_controller
Returns a Spring Boot controller that calls Payram's /api/v1/payment endpoint.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"nextjs",
"express",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_payout_sdk_snippet(framework)
Generates a backend code snippet for creating a payout using the Payram JS/TS SDK.
Esquema de entrada
{
"type": "object",
"properties": {
"framework": {
"type": "string",
"enum": [
"generic-http"
],
"description": "Target framework for the payout SDK snippet"
}
},
"required": [
"framework"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_payout_status_snippet
Generates backend code to query the status of a payout using the Payram SDK.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_payout_recipient_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.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_referral_sdk_snippet(framework)
Generates a backend route or service snippet to create a referral event using the Payram SDK.
Esquema de entrada
{
"type": "object",
"properties": {
"framework": {
"type": "string",
"enum": [
"generic-http"
],
"description": "Target framework for the referral SDK snippet"
}
},
"required": [
"framework"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_referral_validation_snippet
Generates a snippet to validate referral IDs, statuses, and eligibility.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_referral_status_snippet(style)
Generates code to fetch referral progress, rewards, or status.
Esquema de entrada
{
"type": "object",
"properties": {
"style": {
"type": "string",
"enum": [
"sdk",
"backend-only"
],
"description": "Style of code snippet: sdk uses the Payram SDK, backend-only shows direct API calls"
}
},
"required": [
"style"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_referral_route_snippet(framework)
Generates a backend route such as /api/referrals/create for logging referral events.
Esquema de entrada
{
"type": "object",
"properties": {
"framework": {
"type": "string",
"enum": [
"express",
"nextjs"
],
"description": "Web framework for the referral route handler (Express.js or Next.js)"
}
},
"required": [
"framework"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript"
]
},
"framework": {
"type": "string",
"enum": [
"generic-http",
"express",
"nextjs"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_webhook_handler(framework)
Generates backend code to handle Payram webhook HTTP requests.
Esquema de entrada
{
"type": "object",
"properties": {
"framework": {
"type": "string",
"enum": [
"express",
"nextjs",
"fastapi",
"gin",
"laravel",
"spring-boot"
],
"description": "Web framework for the webhook handler code"
}
},
"required": [
"framework"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"express",
"nextjs",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_webhook_event_router
Generates a backend event router that dispatches Payram webhook events to domain handlers.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"express",
"nextjs",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_mock_webhook_event(language, status)
Generates a snippet to send mock Payram webhook events to your local endpoint for testing.
Esquema de entrada
{
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"curl",
"python",
"go",
"php",
"java"
],
"description": "Language/tool for the mock webhook request (curl for command-line testing)"
},
"status": {
"type": "string",
"enum": [
"OPEN",
"CANCELLED",
"FILLED",
"PARTIALLY_FILLED",
"OVER_FILLED",
"UNDEFINED"
],
"description": "Payment status to simulate in the mock webhook event"
}
},
"required": [
"language",
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"typescript",
"javascript",
"python",
"go",
"php",
"java"
]
},
"framework": {
"type": "string",
"enum": [
"express",
"nextjs",
"fastapi",
"gin",
"laravel",
"spring-boot",
"generic-http"
]
},
"filenameSuggestion": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"language",
"framework"
],
"additionalProperties": false
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"meta"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢generate_topup_integration_snippet(part, framework)
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.)
Esquema de entrada
{
"type": "object",
"properties": {
"part": {
"default": "all",
"description": "Which piece to emit: 'schema' (ledger DDL), 'webhook' (cumulative-credit handler), 'settle' (atomic invoice debit), or 'all'.",
"type": "string",
"enum": [
"schema",
"webhook",
"settle",
"all"
]
},
"framework": {
"default": "express",
"description": "Server framework for the webhook handler + settle function.",
"type": "string",
"enum": [
"express",
"fastapi"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"snippet": {
"type": "string"
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"snippet",
"notes"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢explain_payram_basics
Explain Payram's product pillars, architecture, payments, and payouts capabilities.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢get_payram_links
Surface official documentation, website, and community links.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢explain_payment_flow
Describe how payments move from customer initiation through settlement.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢explain_payram_concepts
Glossary-backed explanation of Payram terminology and constraints.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢explain_referrals_basics
Summarize how Payram referral campaigns are configured and managed.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢explain_referral_flow
Detail the referrer/referee lifecycle and required APIs.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢get_referral_dashboard_guide
Explain how to embed and manage the referral dashboard experience.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢prepare_payram_test
Confirm hosting, credentials, and environment variables before generating demo apps.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"path"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"markdown",
"sources"
],
"additionalProperties": false
}
},
"notes": {
"type": "string"
}
},
"required": [
"title",
"sections"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢get_payram_doc_by_id(id)
Returns the markdown for a Payram doc given its id, e.g. "features/payouts".
Esquema de entrada
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"markdown": {
"type": "string"
}
},
"required": [
"id",
"path",
"markdown"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_payram_docs(prefix)
Lists the available Payram doc ids relative to docs/payram-docs-live. Optionally scope by a prefix such as "features".
Esquema de entrada
{
"type": "object",
"properties": {
"prefix": {
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"prefix": {
"type": "string"
},
"count": {
"type": "number"
},
"docs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"count",
"docs"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢scaffold_payram_app(language, framework, appName, includeWebhooks)
Generates a minimal full-stack app skeleton with Payram payments and payouts routes (and a simple UI) for a chosen language and framework.
Esquema de entrada
{
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"node",
"python",
"php",
"go",
"java"
],
"description": "Programming language for the application (node for JavaScript/TypeScript)"
},
"framework": {
"type": "string",
"enum": [
"express",
"nextjs",
"fastapi",
"laravel",
"gin",
"spring-boot"
],
"description": "Web framework to use for scaffolding the application"
},
"appName": {
"description": "Name for the generated application. If not provided, defaults to payram-{framework}-starter",
"type": "string",
"minLength": 1
},
"includeWebhooks": {
"default": true,
"description": "Whether to include webhook handler code in the scaffolded application",
"type": "boolean"
}
},
"required": [
"language",
"framework"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"appName": {
"type": "string"
},
"language": {
"type": "string"
},
"framework": {
"type": "string"
},
"instructions": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"description": {
"type": "string"
},
"contents": {
"type": "string"
}
},
"required": [
"path",
"description",
"contents"
],
"additionalProperties": false
}
}
},
"required": [
"appName",
"language",
"framework",
"instructions",
"files"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Comunidad
Evidencia
Observaciones recientes
verificadoversión no registrada42 herramientas