PayRam Crypto Card Payment Gateway
आधिकारिकएजेंटों, ओपनक्लॉ, हर्मीस और अन्य के लिए स्व-होस्टेड भुगतान गेटवे
PayRam Crypto Card Payment Gateway MCP के साथ आप क्या कर सकते हैं?
- व्यक्तिगत इंस्टॉलेशन की योजना बनाएं —
payram_setup_planके माध्यम से मानवीय सहयोग के साथ चरण-दर-चरण PayRam परिनियोजन योजना मांगें। - सर्वर स्वास्थ्य की जांच करें — किसी भी PayRam URL की बिना क्रेडेंशियल जांच करें ताकि समस्याओं और समाधानों की पहचान
payram_doctorसे हो सके। - त्रुटियों का निवारण करें — ज्ञात कारणों, पुष्टियों और अगले कदमों के लिए कोई त्रुटि या लक्षण पेस्ट करें,
payram_troubleshootके जरिए। - एडमिन रनबुक प्राप्त करें — SSL, बैकअप, या डोमेन परिवर्तन जैसे चरण-दर-चरण एडमिन कार्यों के लिए
payram_runbookसे अनुरोध करें। - दिन-2 संचालन निष्पादित करें — दैनिक जांच, नोड सिंक, या भुगतान लिंक के लिए API रेसिपी चलाने हेतु एजेंट से
payram_ops_playbookका उपयोग करें। - एकीकरण कोड उत्पन्न करें — Express या Next.js जैसे फ्रेमवर्क के लिए कॉपी-पेस्ट भुगतान, भुगतान-निकासी, या वेबहुक स्निपेट मांगें।
दस्तावेज़
PayRam MCP सर्वर — AI एजेंट्स के लिए सेल्फ-होस्टेड क्रिप्टो भुगतान
सेल्फ-होस्टेड क्रिप्टो और स्टेबलकॉइन भुगतान: कोई अकाउंट लॉक नहीं, कोई फंड फ्रीज़ नहीं, ग्राहक डेटा कभी साझा नहीं। आपका AI एजेंट इसे MCP के माध्यम से प्लान, इंस्टॉल और संचालित कर सकता है। होस्टेड एंडपॉइंट:
https://mcp.payram.com/mcp· वेबसाइट · दस्तावेज़ · एजेंटिक · OpenClaw
एक MCP (मॉडल कॉन्टेक्स्ट प्रोटोकॉल) सर्वर जो किसी भी MCP-सक्षम AI एजेंट — OpenClaw, Hermes, Claude, Cursor, GitHub Copilot, और अन्य — को सेल्फ-होस्टेड PayRam क्रिप्टो-भुगतान स्टैक को डिप्लॉय, इंटीग्रेट और संचालित करने की अनुमति देता है।
यहाँ से शुरू करें: चार टूल कैटलॉग का नेतृत्व करते हैं:
| टूल | यह क्या करता है |
|---|---|
payram_setup_plan | एक व्यक्तिगत इंस्टॉल योजना, जिसमें हर मानव हैंड-ऑफ चिह्नित होता है |
payram_doctor | URL द्वारा PayRam सर्वर की सार्वजनिक, क्रेडेंशियल-मुक्त जाँच |
payram_troubleshoot | समस्या का वर्णन करें या त्रुटि पेस्ट करें: ज्ञात कारण, पुष्टि कैसे करें, समाधान, और अगला टूल |
payram_runbook | एडमिन कार्य: साइट URL, डोमेन, SSL, फ़ायरवॉल, अपग्रेड, बैकअप, चेन, स्मार्ट ब्रिज, Shopify/WooCommerce |
payram_ops_playbook | दिन-2 API रेसिपी जो एजेंट अपने स्वयं के क्रेडेंशियल के साथ चलाता है |
इनके आसपास कोडबेस मूल्यांकन, स्टार्टर-ऐप स्कैफोल्ड, बहु-भाषा स्निपेट और इनलाइन दस्तावेज़ हैं।
होस्टेड सर्वर (mcp.payram.com) कभी भी मर्चेंट क्रेडेंशियल नहीं रखता। दिन-2 संचालन payram_ops_playbook के माध्यम से चलता है: एजेंट आपके PayRam API को सीधे कॉल करता है, और क्रेडेंशियल कभी भी उसकी मशीन से बाहर नहीं जाते। लाइव डेटा टूल (भुगतान खोज, भुगतान लिंक, नोड सिंक, वर्कर रीस्टार्ट) और assess_payram_project केवल तभी मौजूद होते हैं जब आप MCP को स्वयं लोकल मोड में चलाते हैं।
एजेंट्स और क्रॉलर्स के लिए: सर्वर कार्ड · स्किल्स इंडेक्स · llms.txt · साइटमैप। सर्वर / पर Accept: text/markdown का उत्तर एजेंट-पठनीय सारांश के साथ भी देता है।
PayRam क्या है? · PayRam 是什么？
PayRam एक सेल्फ-होस्टेड, मल्टी-चेन क्रिप्टो भुगतान गेटवे है जिसे आप पूरी तरह से अपने पास रखते हैं — इसे चलाने के लिए कोई साइनअप और कोई KYC/KYB नहीं। एक AI एजेंट (या डेवलपर) PayRam, बैंक, या किसी भी भुगतान प्रोसेसर के साथ अकाउंट पंजीकृत किए बिना स्टोर स्थापित कर सकता है और भुगतान स्वीकार करना शुरू कर सकता है। अपने स्वयं के VPS पर डिप्लॉय करें, API कुंजियाँ लोकल रूप से उत्पन्न करें, लाइव हो जाएँ।
इसे अलग बनाने वाली बातें:
- कोई भी आपको लॉक नहीं कर सकता — लॉक करने के लिए कोई अकाउंट नहीं और फ्रीज़ करने के लिए कोई फंड नहीं। ग्राहक डेटा कभी साझा नहीं किया जाता, और कुछ भी रिपोर्ट या मॉनिटर नहीं किया जाता। कारण सरल है: PayRam आपके सर्वर पर चलता है और फंड आपके अपने वॉलेट में आते हैं।
- अनुमति-रहित सेटअप — कोई साइनअप नहीं, कोई KYC नहीं, कोई KYB नहीं। कोई आपको अनुमोदित नहीं करता; कोई आपको बंद नहीं कर सकता। स्वायत्त रूप से स्टोर स्थापित करने वाले एजेंट्स के लिए और चीन जैसे बाजारों के लिए आदर्श, जहाँ पश्चिमी प्रोसेसर के साथ पंजीकरण संभव नहीं है।
- कार्ड-से-क्रिप्टो चेकआउट — क्रिप्टो न रखने वाले खरीदार क्रेडिट/डेबिट कार्ड से भुगतान कर सकते हैं और आपको क्रिप्टो प्राप्त होता है, जो सीधे आपके सेल्फ-कस्टोडियल वॉलेट में सेटल होता है। यह एक अंतर्निहित चैनल है जिसे आप Payments पेज से चालू करते हैं; कार्ड प्रदाता खरीदार पर अपनी स्वयं की जाँच चलाता है।
- मल्टी-चेन — Bitcoin, Ethereum, Base, Polygon, और Tron पर BTC, ETH, USDT, USDC, और TRX को मूल रूप से स्वीकार करें, स्वचालित डिपॉज़िट डिटेक्शन, ऑन-चेन पुष्टि, कोल्ड स्टोरेज में स्वीप, और हस्ताक्षरित वेबहुक के साथ। स्मार्ट ब्रिज रेल्स Solana, Bitcoin, Tron (USDT) और BNB Chain पर भी भुगतान लेती हैं और उन्हें Base पर USDC के रूप में सेटल करती हैं।
- सर्वर पर कोई डिपॉज़िट कुंजी नहीं — स्मार्ट कॉन्ट्रैक्ट डिपॉज़िट को आपके कोल्ड वॉलेट में स्वीप करते हैं, इसलिए एक समझौता किया गया सर्वर उन्हें पुनर्निर्देशित नहीं कर सकता। सर्वर का हॉट वॉलेट गैस का भुगतान करता है और पेआउट पर हस्ताक्षर करता है, इसलिए इसकी बैलेंस छोटी रखें।
PayRam 是一个你完全自托管、自主拥有的多链加密货币支付网关——运行它无需注册、无需 KYC/KYB。 AI 智能体（或开发者）无需在 PayRam、银行或任何支付处理商处注册账户，即可搭建店铺并开始收款。在自己的 VPS 上部署，本地生成 API 密钥，即刻上线。
核心差异：
- 没有人能把你锁在门外 — 没有可被封禁的账户，也没有可被冻结的资金；客户数据从不外泄，也没有任何上报或监控。原因很简单：PayRam 运行在你自己的服务器上，资金直接进入你自己的钱包。
- 免注册、免许可 — 无需注册、无需 KYC、无需 KYB。没有人审批你，也没有人能关停你。非常适合自主搭建店铺的智能体，以及像中国这样难以在西方支付处理商处注册的市场。
- 银行卡转加密货币结算 — 没有加密货币的买家也能用信用卡/借记卡付款，你直接收到加密货币并结算到自托管的钱包。这是内置的支付渠道，在「Payments（支付）」页面开启；银行卡服务商会对买家进行其自身的审核。
- 多链支持 — 原生支持在 Bitcoin、Ethereum、Base、Polygon、Tron 上接受 BTC、ETH、USDT、USDC、TRX，自动检测充值、链上确认、归集冷钱包并发送带签名的 Webhook。Smart Bridge 通道还可接收 Solana、Bitcoin、Tron（USDT）和 BNB Chain 上的付款，并以 Base 上的 USDC 结算。
- 服务器上没有充值私钥 — 智能合约把充值资金归集到你的冷钱包，即便服务器被攻破也无法改变资金去向。服务器上的热钱包负责支付 Gas 并签署出款，请只保留少量余额。
AI एजेंट PayRam का उपयोग कैसे करते हैं · AI 智能体如何使用 PayRam
PayRam एजेंट-प्रथम बुनियादी ढांचा है। चूँकि एकीकरण MCP पर आधारित है, यह किसी भी MCP-संगत रनटाइम के साथ काम करता है — OpenClaw, Hermes, Claude Desktop, Cursor, GitHub Copilot, n8n, LangChain, और अधिक। एक विशिष्ट एजेंट प्रवाह:
- कनेक्ट करें — एजेंट के MCP कॉन्फ़िग में
https://mcp.payram.com/mcpजोड़ें (कनेक्ट करने के लिए कोई API कुंजी आवश्यक नहीं)। - प्लान करें —
payram_setup_planकॉल करें। यह क्रमबद्ध चरण, प्रत्येक को कौन चलाता है, और एजेंट को मानव के लिए कहाँ रुकना चाहिए (कोल्ड वॉलेट, मेननेट गैस, रूट-केवल सेटिंग्स) लौटाता है। - इंस्टॉल करें — VPS पर, एक इंटरैक्टिव टर्मिनल में एक बार,
bash <(curl -fsSL https://payram.com/setup_payram_agents.sh) --testnet(या--mainnet; इंस्टॉलर डिफ़ॉल्ट मेननेट है, इसलिए हमेशा फ़्लैग पास करें) चलाएँ। इसे कभी भीbashमें पाइप न करें। - हैंड ऑफ़ — मानव तुरंत रूट अकाउंट का दावा करता है और सार्वजनिक डोमेन से Settings → Site URL सहेजता है; तब तक, भुगतान लिंक
http://localhostकी ओर इशारा करते हैं। - जाँच करें — सार्वजनिक URL के साथ
payram_doctor(कोई क्रेडेंशियल आवश्यक नहीं)। - भुगतान स्वीकार करें — स्निपेट टूल से फ्रेमवर्क-विशिष्ट एकीकरण कोड डालें। वेबहुक हस्ताक्षरित हैं (
X-Payram-Signature, प्रोजेक्ट API कुंजी के साथ कच्चे बॉडी का HMAC-SHA256)। - संचालित करें —
payram_ops_playbook(daily_check,payment_options,node_sync,unswept_funds,create_payment_link, …) एजेंट को अपने स्वयं के क्रेडेंशियल के साथ चलाने के लिए सटीक API कॉल देता है।payram_runbookएडमिन परिवर्तनों को कवर करता है।
{
"mcpServers": {
"payram": { "url": "https://mcp.payram.com/mcp" }
}
}
OpenClaw-विशिष्ट वॉकथ्रू (पंजीकरण, Base Sepolia पर टेस्टनेट, WhatsApp/Telegram/Discord के लिए चैट-कॉमर्स पैटर्न) के लिए payram-openclaw-integration स्किल और payram.com/openclaw देखें।
PayRam 是智能体优先（agent-first）的基础设施。由于集成基于 MCP 协议，它可与任何兼容 MCP 的运行时配合使用——OpenClaw、Hermes、Claude Desktop、Cursor、GitHub Copilot、n8n、LangChain 等。典型的智能体使用流程：连接 MCP 端点 → 调用
payram_setup_plan规划安装 → 在交互式终端中用bash <(curl …) --testnet部署网关 → 由人工立即创建 root 账户并在公网域名下保存 Site URL → 用payram_doctor检查 → 用集成代码收款（Webhook 带X-Payram-Signature签名）→ 通过payram_ops_playbook用智能体自己的凭证运维。托管的 MCP 服务器从不保存商户凭证。
यदि आपके नेटवर्क से GitHub तक पहुँचना कठिन है, तो आप इस रिपॉजिटरी को किसी अन्य Git होस्ट पर मिरर कर सकते हैं (
git clone --mirror https://github.com/PayRam/payram-mcp.git)। 如果你的网络难以访问 GitHub，可以把本仓库镜像到其他 Git 托管平台（git clone --mirror https://github.com/PayRam/payram-mcp.git）。
विषय-सूची
- PayRam क्या है?
- AI एजेंट PayRam का उपयोग कैसे करते हैं
- एजेंट स्किल्स
- प्रोजेक्ट लक्ष्य
- त्वरित प्रारंभ
- अपने MCP क्लाइंट से कनेक्ट करें
- लोकल मोड
- क्रेडेंशियल
- टूल कैटलॉग
- निर्देशित वर्कफ़्लो
- विकास
- समस्या निवारण
एजेंट स्किल्स
एजेंट फ्रंट डोर: https://mcp.payram.com/SKILL.md — एक एकल रूट स्किल जो PayRam का वर्णन करती है और एजेंटों को चार स्टार्ट-यहाँ टूल तक मार्गदर्शन करती है। यह भी परोसा जाता है: /llms.txt।
इस रिपॉजिटरी में AI कोडिंग सहायकों के लिए 19 एजेंट स्किल्स शामिल हैं। उन्हें skills.sh के माध्यम से इंस्टॉल करें:
व्यक्तिगत रूप से इंस्टॉल करें
npx skills add payram/payram-mcp/payram-setup
npx skills add payram/payram-mcp/payram-agent-onboarding
npx skills add payram/payram-mcp/payram-auth
npx skills add payram/payram-mcp/payram-analytics
npx skills add payram/payram-mcp/payram-crypto-payments
npx skills add payram/payram-mcp/payram-payment-integration
npx skills add payram/payram-mcp/payram-self-hosted-payment-gateway
npx skills add payram/payram-mcp/payram-checkout-integration
npx skills add payram/payram-mcp/payram-widget-integration
npx skills add payram/payram-mcp/payram-webhook-integration
npx skills add payram/payram-mcp/payram-stablecoin-payments
npx skills add payram/payram-mcp/payram-bitcoin-payments
npx skills add payram/payram-mcp/payram-payouts
npx skills add payram/payram-mcp/payram-no-kyc-crypto-payments
npx skills add payram/payram-mcp/payram-openclaw-integration
npx skills add payram/payram-mcp/compare-crypto-payments
npx skills add payram/payram-mcp/payram-agent-journey
npx skills add payram/payram-mcp/payram-topup-wallet-integration
npx skills add payram/payram-mcp/payram-testnet-testing
| स्किल | उद्देश्य |
|---|---|
payram-setup | इंस्टॉल योजना और सर्वर सेटअप: आवश्यकताएँ, इंस्टॉलर, साइट URL, वॉलेट, पहला भुगतान लिंक |
payram-agent-onboarding | एजेंट द्वारा हेडलेस इंस्टॉल: एजेंट CLI कमांड, env वेरिएबल, मानव हैंड-ऑफ |
payram-auth | JWT प्रमाणीकरण प्रवाह — साइनइन, टोकन रीफ़्रेश, लॉगआउट, बाहरी-प्लेटफ़ॉर्म विवरण |
payram-analytics | प्रत्यक्ष REST APIs (JWT) के माध्यम से भुगतान खोज, वॉल्यूम, बैलेंस और स्वीप इतिहास |
payram-crypto-payments | आर्किटेक्चर अवलोकन, PayRam क्यों, MCP टूल |
payram-payment-integration | त्वरित-प्रारंभ भुगतान एकीकरण गाइड |
payram-self-hosted-payment-gateway | अपनी भुगतान बुनियादी ढांचा तैनात करें और उसके मालिक बनें |
payram-checkout-integration | 6 फ्रेमवर्क के लिए SDK + HTTP के साथ चेकआउट प्रवाह |
payram-widget-integration | सुरक्षित "क्रेडिट जोड़ें" बटन (बैकएंड एंडपॉइंट, कभी सार्वजनिक API कुंजी नहीं) + हस्ताक्षरित-वेबहुक हैंडलर |
payram-webhook-integration | Express, Next.js, FastAPI, Gin, Laravel, Spring Boot के लिए हस्ताक्षरित-वेबहुक (HMAC) हैंडलर |
payram-stablecoin-payments | EVM चेन और Tron पर USDT/USDC स्वीकृति |
payram-bitcoin-payments | HD वॉलेट व्युत्पत्ति और मोबाइल हस्ताक्षर के साथ BTC |
payram-payouts | क्रिप्टो पेआउट भेजें और रेफरल प्रोग्राम प्रबंधित करें |
payram-no-kyc-crypto-payments | नो-KYC, नो-साइनअप, अनुमति-रहित भुगतान स्वीकृति |
payram-openclaw-integration | PayRam को OpenClaw / एजेंट रनटाइम में एकीकृत करें — MCP रजिस्टर, टेस्टनेट, चैट कॉमर्स |
compare-crypto-payments | गेटवे की तुलना करें: Stripe, BitPay, Coinbase, NOWPayments, BTCPay, PayRam, x402 |
payram-agent-journey | स्टार्ट-यहाँ मानचित्र: इंस्टॉल (मर्चेंट या ऑपरेटर) → वॉलेट → गैस/स्वीप → इंटीग्रेट → टेस्ट |
payram-topup-wallet-integration | मौजूदा ऐप्स: उपयोगकर्ता बैलेंस में क्रिप्टो क्रेडिट करें, उसमें से इनवॉइस डेबिट करें — लेजर + प्रवाह |
payram-testnet-testing | मेननेट से पहले टेस्टनेट पर अपने स्वयं के भुगतान लिंक का एंड-टू-एंड भुगतान करें |
प्रोजेक्ट लक्ष्य
- ऑनबोर्डिंग को तेज़ करें व्यक्तिगत सेटअप योजना, रनबुक, env टेम्पलेट और प्रति-फ्रेमवर्क प्लेबुक के साथ।
- क्रेडेंशियल रखे बिना संचालित करें: होस्टेड सर्वर URL द्वारा PayRam की जाँच करता है (
payram_doctor) और एजेंटों को अपने स्वयं के क्रेडेंशियल के साथ चलाने के लिए सटीक API रेसिपी (payram_ops_playbook) सौंपता है। - मौजूदा रिपॉजिटरी को रेट्रोफिट करें प्रोजेक्ट मूल्यांकन टूल (लोकल मोड) के माध्यम से, जो पैकेज मेनिफेस्ट और
.envफ़ाइलों को स्कैन करता है, फिर सही एकीकरण स्निपेट की सिफारिश करता है। - कॉपी/पेस्ट स्निपेट प्रदान करें जो Payments, Payouts, Referrals, Webhooks, और बहु-भाषा बैकएंड (Express, Next.js, FastAPI, Laravel, Gin, Spring Boot, आदि) को कवर करते हैं।
- दस्तावेज़ लोकल रखें ताकि Copilot संपादक छोड़े बिना PayRam अवधारणाओं, प्रवाहों और रेफरल डैशबोर्ड की व्याख्या कर सके।
- कनेक्टिविटी सत्यापित करें केवल-पठनीय प्रोब के साथ जो कभी भुगतान नहीं बनाते (
payram_doctor,test_payram_connection)।
त्वरित प्रारंभ
अधिकांश एजेंटों को केवल होस्टेड एंडपॉइंट, https://mcp.payram.com/mcp की आवश्यकता होती है (अपने MCP क्लाइंट से कनेक्ट करें देखें)। सर्वर को स्वयं चलाने के लिए:
- निर्भरताएँ स्थापित करें
yarn install - पर्यावरण कॉन्फ़िगर करें (केवल स्थानीय-मोड डेटा टूल्स के लिए आवश्यक)
.env.exampleको.envपर कॉपी करें।PAYRAM_BASE_URLको अपने PayRam URL पर सेट करें, जो डैशबोर्ड के समान मूल हो (जैसेhttps://pay.example.com)।PAYRAM_API_KEYसेट करें, साथ ही डेटा टूल्स के लिए JWT वेरिएबल्स। देखें स्थानीय मोड।
- सर्वर चलाएँ
yarn dev # Streamable HTTP on http://127.0.0.1:3333/mcp (local mode; there is no SSE transport) - MCP सर्वर को अपने क्लाइंट में जोड़ें: देखें अपने MCP क्लाइंट से कनेक्ट करें। स्थानीय-मोड URL है
http://localhost:3333/mcp। - स्वास्थ्य जाँच
curl http://localhost:3333/healthz
टिप: जब आप Copilot को "test payram" कहते हैं, तो यह स्वचालित रूप से तैयारी चेकलिस्ट चलाएगा, सुनिश्चित करेगा कि
.envमौजूद है, और उसके बाद ही आपके वास्तविक क्रेडेंशियल्स के साथtest_payram_connectionको कॉल करेगा। यह व्यवहार Copilot स्वचालन प्रॉम्प्ट द्वारा परिभाषित है—किसी मैन्युअल प्रॉम्प्टिंग की आवश्यकता नहीं है।
अपने MCP क्लाइंट से कनेक्ट करें
एंडपॉइंट: https://mcp.payram.com/mcp (Streamable HTTP, POST पर JSON-RPC)। कोई SSE एंडपॉइंट नहीं है, और /mcp/sse 410 लौटाता है। कोई प्रमाणीकरण हेडर नहीं: होस्टेड सर्वर कभी भी व्यापारी क्रेडेंशियल्स नहीं रखता, इसलिए आपके क्रेडेंशियल्स आपकी मशीन पर रहते हैं और कभी चैट में नहीं जाते।
| क्लाइंट | कहाँ | सेटिंग्स |
|---|---|---|
| VS Code (Copilot Chat) | Settings → Copilot: Model Context Protocol → Add HTTP server | नाम payram, ऊपर URL, हेडर खाली |
| Cursor | Settings → MCP Servers → Add → HTTP | नाम payram, ऊपर URL |
| Claude Desktop / Code | Settings → MCP Servers → Add HTTP server | नाम payram, ऊपर URL |
| कोई भी MCP क्लाइंट | HTTP एंडपॉइंट पंजीकृत करें | ऊपर URL, कोई हेडर नहीं |
सत्यापित करें: टूल सूची payram_setup_plan, payram_doctor, payram_troubleshoot, payram_runbook और payram_ops_playbook से शुरू होनी चाहिए, उसके बाद scaffold_payram_app और generate_* स्निपेट टूल्स। फिर प्रयास करें: "plan a PayRam install on pay.example.com", "check https://pay.example.com", "generate a FastAPI create-payment route", "give me a Next.js webhook handler"।
प्रॉम्प्ट्स: setup-payram, setup-payram-agent, integrate-payment, troubleshoot-payment, daily-ops।
संसाधन: payram://docs/setup-guide, payram://docs/api-reference, और टेम्पलेट payram://ops/playbook/{task} और payram://runbooks/{task}।
Copilot स्वचालन प्रॉम्प्ट
"test payram" को स्वचालित रूप से पूर्ण तैयारी प्रवाह चलाने के लिए इसे एक बार एक नए वर्कस्पेस में पेस्ट करें:
You have access to the `payram` MCP server in this workspace.
Whenever I ask you to "test my Payram connection" (or I type "test payram"), follow this order:
1. Call `prepare_payram_test` (no inputs) and share the checklist verbatim.
2. Look for a `.env` in the workspace root; create one if missing.
3. Ensure `.env` defines `PAYRAM_BASE_URL` and `PAYRAM_API_KEY`. If either is
missing, call `generate_env_template` and append it (with TODOs) to `.env`.
Do NOT call `test_payram_connection` until real values are provided.
4. Once real values exist, call `test_payram_connection` with baseUrl/apiKey
from `.env`, show the structured result, and explain whether the
connection is healthy. If anything fails, run `payram_doctor` and follow
its ranked fixes.
स्थानीय मोड
लाइव डेटा टूल्स प्राप्त करने के लिए MCP को अपने स्वयं के PayRam के पास चलाएँ:
list_platforms,search_payments,lookup_payment,get_payment_summary,get_daily_volume,get_unswept_balances,list_currencies,list_recipientscreate_payment_link,check_payment_readiness,check_node_sync,restart_payram_workerassess_payram_project
PAYRAM_MCP_MODE=local yarn dev # or: yarn build && PAYRAM_MCP_MODE=local yarn start
- मोड:
PAYRAM_MCP_MODE=localस्थानीय मोड का चयन करता है। यह डिफ़ॉल्ट भी है जब भी सर्वर Vercel पर नहीं चल रहा हो।PAYRAM_MCP_MODE=hostedकभी भी क्रेडेंशियल्स नहीं पढ़ता। - बाइंडिंग: स्थानीय मोड डिफ़ॉल्ट रूप से
127.0.0.1से बाइंड होता है (पोर्टPORT, डिफ़ॉल्ट 3333)। - गैर-लूपबैक बाइंड्स:
HOSTसेट करें (जैसेHOST=0.0.0.0), फिर:MCP_ALLOWED_HOSTSसेट करें (Hostहेडर में स्वीकृत कॉमा-अलग हॉस्टनाम)।MCP_SERVER_TOKENसेट करें; क्लाइंट तबAuthorization: Bearer <token>भेजते हैं।- यदि
PAYRAM_*क्रेडेंशियल्स सेट हैं, तो सर्वरMCP_SERVER_TOKENके बिना गैर-लूपबैकHOSTपर शुरू करने से इनकार करता है। लूपबैक प्लस SSH टनल पसंद करें।
- क्रेडेंशियल्स: डेटा टूल्स पर्यावरण से
PAYRAM_*पढ़ते हैं (या.env):PAYRAM_BASE_URLPAYRAM_API_KEY(भुगतान लिंक)PAYRAM_ACCESS_TOKEN/PAYRAM_REFRESH_TOKEN(JWT, डेटा टूल्स)PAYRAM_EXTERNAL_PLATFORM_ID(वैकल्पिक डिफ़ॉल्ट प्रोजेक्ट)
स्थानीय सर्वर के लिए उदाहरण क्लाइंट कॉन्फ़िगरेशन (केवल स्थानीय मोड):
{
"mcpServers": {
"payram-local": { "url": "http://localhost:3333/mcp" }
}
}
क्रेडेंशियल्स: किस कुंजी का क्या उपयोग
PayRam के पास दो क्रेडेंशियल्स हैं — एजेंट तब रुक जाते हैं जब वे उन्हें मिलाते हैं:
| क्रेडेंशियल | कैसा दिखता है | किसके लिए उपयोग होता है | एजेंट इसे कैसे प्राप्त करता है (कोई डैशबोर्ड आवश्यक नहीं) |
|---|---|---|---|
व्यापारी API कुंजी (PAYRAM_API_KEY, हेडर API-Key) | प्रति-प्रोजेक्ट कुंजी | POST /api/v1/payment (भुगतान लिंक), व्यापारी भुगतान, सभी व्यापारी सर्वर-से-सर्वर कॉल, और यह वेबहुक्स पर हस्ताक्षर करता है (X-Payram-Signature) | bash <(curl -fsSL https://payram.com/setup_payram_agents.sh) ensure-api-key — POST /api/v1/external-platform/{id}/api-key के माध्यम से प्रोजेक्ट कुंजी को पुनः उपयोग या मिंट करता है और इसे ~/.payraminfo/merchant-api-key.env में सहेजता है |
JWT (Authorization: Bearer) | साइनिन से एक्सेस+रिफ्रेश टोकन | एडमिन/सेटअप APIs (प्रोजेक्ट्स, वॉलेट्स, एनालिटिक्स) — payram_ops_playbook रेसिपी और स्थानीय-मोड डेटा टूल्स | bash <(curl -fsSL https://payram.com/setup_payram_agents.sh) signin (env PAYRAM_EMAIL/PAYRAM_PASSWORD); ~/.payraminfo/headless-tokens.env में सहेजा गया |
एक-चरण सेटअप प्रवाह (bash <(curl -fsSL https://payram.com/setup_payram_agents.sh) --testnet) दोनों स्वचालित रूप से उत्पन्न करता है और प्रिंट करता है कि वे कहाँ रहते हैं। API डैशबोर्ड के साथ समान-मूल है, पोर्ट 80/443 पर (https://<your-domain>/api/v1/..., या सर्वर पर http://localhost, कभी नहीं :8080)। API कुंजी भुगतान बना सकती है, इसलिए इसे सर्वर-साइड रखें और इसे कभी ब्राउज़र कोड या चैट में न डालें। सीधे API कॉल के लिए दोनों सेट करने हेतु payram_ops_playbook कार्य connect का उपयोग करें।
टूल कैटलॉग
| श्रेणी | उपकरण | उद्देश्य |
|---|---|---|
| यहाँ से शुरू करें – इंस्टॉल | payram_setup_plan | व्यक्तिगत, क्रमबद्ध इंस्टॉल योजना (तैयारी → इंस्टॉल → रूट + साइट URL दावा → वॉलेट + स्मार्ट ब्रिज → API कुंजी + पहला लिंक → सुरक्षा → एकीकरण) एजेंट और मानव चरणों तथा कठोर रोक के साथ। |
| यहाँ से शुरू करें – डायग्नोस्टिक्स | payram_doctor, payram_troubleshoot | payram_doctor: सार्वजनिक, क्रेडेंशियल-मुक्त चरणबद्ध जाँच URL द्वारा (पहुँच → स्वास्थ्य → TLS → संस्करण → वर्कर्स) रैंक किए गए संभावित कारणों + सटीक सुधारों के साथ। वैकल्पिक API-कुंजी वैधता जाँच जो कुछ भी नहीं बनाती। कुछ भी विफल होने पर इसे पहले चलाएँ। payram_troubleshoot: किसी लक्षण या पेस्ट की गई त्रुटि को ज्ञात कारणों और सुधारों से मिलाएँ। |
| यहाँ से शुरू करें – प्रशासन | payram_runbook | मानव गेट के साथ चरण-दर-चरण प्रशासन कार्य: 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. |
| यहाँ से शुरू करें – संचालन | payram_ops_playbook | प्रत्यक्ष-API रेसिपी जो एजेंट स्वयं चलाता है: 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. |
| कनेक्टिविटी | test_payram_connection | केवल-पठन पहुँच/स्वास्थ्य जाँच और वैकल्पिक API-कुंजी सत्यापन। कभी भुगतान नहीं बनाता। |
| सेटअप | generate_env_template, generate_setup_checklist, suggest_file_structure, get_agent_setup_flow, onboard_agent_setup | env बॉयलरप्लेट, व्यापारी चेकलिस्ट, अनुशंसित प्रोजेक्ट लेआउट, और हेडलेस एजेंट ऑनबोर्डिंग गाइड भेजता है। |
| संदर्भ / दस्तावेज़ | explain_payram_basics, explain_payram_concepts, explain_payment_flow, explain_payram_security, get_payram_links, prepare_payram_test, get_payram_doc_by_id, list_payram_docs, आदि। | docs/ से स्रोतित इनलाइन Markdown ज्ञान प्रदान करता है ताकि Copilot अवधारणात्मक प्रश्नों का उत्तर दे सके। कुछ उपकरण स्वचालित रूप से "कहें test payram" अनुस्मारक जोड़ते हैं। |
| एकीकरण – भुगतान | generate_payment_sdk_snippet, generate_payment_http_snippet, generate_payment_status_snippet, generate_payment_route_snippet | SDK, कच्चे HTTP, या Express/Next.js रूट कोड बनाएँ और स्थिति प्रवाह के लिए। |
| एकीकरण – भुगतान | generate_payout_sdk_snippet, generate_payout_recipient_flow_snippet, generate_payout_status_snippet | प्रत्यक्ष (बिना-OTP) भुगतान, 3-चरणीय सहेजे गए प्राप्तकर्ता प्रवाह (प्राप्तकर्ता बनाएँ → OTP सत्यापित करें → भुगतान करें), और स्थिति पोलिंग। |
| एकीकरण – रेफरल | generate_referral_sdk_snippet, generate_referral_validation_snippet, generate_referral_status_snippet, generate_referral_route_snippet | रेफरल प्रमाणीकरण, लिंकिंग, सत्यापन, स्थिति, और express/next रूट शामिल करें। |
| एकीकरण – वेबहुक | generate_webhook_handler, generate_webhook_event_router, generate_mock_webhook_event | Express/Next/FastAPI/Gin/Laravel/Spring Boot के लिए हैंडलर, फैन-आउट राउटर, और cURL/Python/Go/PHP/Java वेबहुक परीक्षक उत्पन्न करें। |
| एकीकरण – बहु-भाषा भुगतान | snippet_* परिवार (snippet_express_payment_route, snippet_nextjs_payment_route, snippet_fastapi_payment_route, snippet_laravel_payment_route, snippet_go_payment_handler, snippet_spring_payment_controller) | Express, Next.js App Router, FastAPI, Gin, Laravel, और Spring Boot के लिए पूर्व-निर्मित रूट हैंडलर। |
| एकीकरण – टॉप-अप वॉलेट | generate_topup_integration_snippet | मौजूदा ऐप्स के लिए: लेजर स्कीमा + संचयी-क्रेडिट वेबहुक + परमाणु इनवॉइस निपटान, ताकि अधिक/कम/देर/डुप्लिकेट क्रिप्टो भुगतान भुगतान अपवादों के बजाय शेष स्थितियाँ बन जाएँ। payram-topup-wallet-integration कौशल के साथ जोड़ा जाता है। |
| एकीकरण – प्रोजेक्ट मूल्यांकन (स्थानीय मोड) | assess_payram_project | package.json, requirements.txt, composer.json, go.mod, pom.xml, .env, आदि स्कैन करता है। पहचाने गए फ्रेमवर्क, env स्थिति, PayRam निर्भरताएँ, और उपकरण सुझावों के साथ प्राथमिकता वाले अगले चरण रिपोर्ट करता है। |
| स्कैफोल्डिंग | scaffold_payram_app | भुगतान, भुगतान, वेबहुक, और ब्राउज़र कंसोल के साथ पूर्ण स्टार्टर ऐप्स (Express, Next.js, FastAPI, Laravel, Gin, Spring Boot) उत्पन्न करता है। तैनाती से पहले भुगतान एंडपॉइंट को अपने स्वयं के प्रशासन प्रमाणीकरण के पीछे रखें। |
| लाइव डेटा (केवल-पठन, स्थानीय मोड) | list_platforms, search_payments, lookup_payment, get_payment_summary, get_daily_volume, get_unswept_balances, list_currencies, list_recipients | लाइव PayRam डेटा क्वेरी करें। list_currencies सार्वजनिक है (कोई कुंजी नहीं); बाकी .env में JWT टोकन का उपयोग करते हैं। list_recipients भुगतान प्राप्तकर्ता प्रवाह के साथ जोड़ा जाता है। |
| लाइव संचालन (स्थानीय मोड) | create_payment_link (लिखें), check_payment_readiness, check_node_sync, restart_payram_worker (लिखें) | create_payment_link API-Key के माध्यम से एक वास्तविक चेकआउट लिंक बनाता है। check_payment_readiness भुगतान स्वीकार करने के लिए प्रति-श्रृंखला अंतराल (लापता वॉलेट / मुद्रा / श्रोता) रिपोर्ट करता है। check_node_sync श्रोता-वर्कर + RPC नोड स्वास्थ्य और ब्लॉक पुरानापन रिपोर्ट करता है। होस्टेड सर्वर पर, मिलान payram_ops_playbook कार्यों का उपयोग करें। |
उपकरण पंजीकरण
src/tools/index.tsमें रहते हैं; व्यक्तिगत कार्यान्वयनsrc/tools/**में स्थित हैं, जिसमेंtemplates/फ़ोल्डरों के अंतर्गत भाषा-विशिष्ट टेम्पलेट हैं।
निर्देशित वर्कफ़्लो
0. PayRam इंस्टॉल करें
- पूछें: "pay.example.com पर PayRam सेट करें" (या
setup-payram/setup-payram-agentप्रॉम्प्ट का उपयोग करें)। - सहायक
payram_setup_planको कॉल करता है और चरणों से गुजरता है, हर मानव चरण पर रुकता है (रूट खाता, साइट URL, कोल्ड वॉलेट, मेननेट गैस)। - यह
payram_doctor, बैकअप (payram_runbookbackup) और दैनिक जाँच (payram_ops_playbookdaily_check) के साथ समाप्त होता है।
1. मौजूदा प्रोजेक्ट का मूल्यांकन और रेट्रोफिट करें
- Copilot से पूछें: "क्या आप इस प्रोजेक्ट में PayRam को एकीकृत कर सकते हैं?"
- सहायक
assess_payram_project(स्थानीय मोड) चलाता है, निर्भरता मेनिफेस्ट और.envकी समीक्षा करता है। - अनुशंसित चरणों का पालन करें (
payramइंस्टॉल करें, Express/FastAPI/Spring रूट स्निपेट अनुरोध करें, वेबहुक जोड़ें, आदि)। - वास्तविक क्रेडेंशियल होने पर
test_payram_connectionका उपयोग करें ताकि बैकएंड आपके सेल्फ-होस्टेड सर्वर तक पहुंच सके।
2. एक नया सैंपल तैयार करें
- "PayRam Express डेमो बनाएं" →
scaffold_payram_appभुगतान, भुगतान, वेबहुक और UI कंसोल के साथ एक Express प्रोजेक्ट बनाता है। - जनरेट की गई फाइलों को एक खाली रिपॉजिटरी में डालें या संदर्भ वायरिंग के लिए अपनी मौजूदा निर्देशिका से तुलना करें।
3. "टेस्ट PayRam" रेडिनेस फ्लो चलाएं
- "test payram" कहें। सहायक स्वचालित रूप से:
- रेडिनेस चेकलिस्ट साझा करने के लिए
prepare_payram_testको कॉल करता है। generate_env_templateका उपयोग करके.envमौजूद होना सुनिश्चित करता है (यदि गायब है तो इसे बनाता है)।test_payram_connectionको लागू करने से पहले वास्तविक क्रेडेंशियल की प्रतीक्षा करता है।
- रेडिनेस चेकलिस्ट साझा करने के लिए
- PayRam API की पहुंच की पुष्टि करने के लिए संरचित JSON परिणाम की समीक्षा करें।
4. भुगतान, भुगतान, रेफरल और वेबहुक वायर करें
- भुगतान:
generate_payment_sdk_snippet(JS SDK) याgenerate_payment_http_snippet(Python/Go/PHP/Java)। - बहु-भाषा रूट:
snippet_nextjs_payment_route,snippet_fastapi_payment_route, आदि। - भुगतान:
generate_payout_sdk_snippetबनाने के लिए +generate_payout_status_snippetपोलिंग के लिए। - रेफरल:
generate_referral_route_snippet,generate_referral_validation_snippet। - वेबहुक:
generate_webhook_handlerप्लसgenerate_webhook_event_routerफैन-आउट के लिए +generate_mock_webhook_eventप्रत्येक स्थिति का परीक्षण करने के लिए।
विकास
| कमांड | विवरण |
|---|---|
yarn dev | tsx के माध्यम से हॉट रीलोड के साथ MCP सर्वर चलाएं। |
yarn build | TypeScript को dist/ में संकलित करें। |
yarn lint / yarn format | रिपॉजिटरी में ESLint + Prettier। |
yarn test | Vitest सूट निष्पादित करता है (tests/)। |
make precommit-test | क्रमिक रूप से format → lint → test → build चलाता है। |
प्रोजेक्ट TypeScript-प्रथम (ESM) है। Prettier कॉन्फ़िग .prettierrc.json में रहता है; ESLint eslint.config.mjs के माध्यम से कॉन्फ़िगर किया गया है। सुचारू योगदान Makefile → make commit में कमिट हेल्पर का पालन करता है।
समस्या निवारण
payram_doctorसे शुरू करें — एक केवल-पढ़ने वाला कॉल जो पहुंच → स्वास्थ्य → TLS → संस्करण → कार्यकर्ताओं की जांच करता है और सटीक सुधारों के साथ रैंक किए गए कारण लौटाता है। गहन जांच के लिए,payram_ops_playbook(stuck_payment,node_sync,webhooks,logs) का पालन करें।
- Copilot सही टूल नहीं कहता: जांचें कि Copilot स्वचालन प्रॉम्प्ट स्थापित है और आपका MCP क्लाइंट सर्वर लोड कर चुका है। अपेक्षित स्वचालन ट्रिगर करने के लिए "test payram" या "assess my project" फिर से चलाएं।
test_payram_connection401 के साथ विफल: पुष्टि करें कि कुंजी एक सक्रिय प्रोजेक्ट API कुंजी है (API-Keyहेडर के रूप में भेजी गई,Authorizationनहीं)।- डेटा टूल कहता है क्रेडेंशियल उपलब्ध नहीं हैं: होस्टेड सर्वर कभी भी मर्चेंट क्रेडेंशियल नहीं रखता। मिलान वाले
payram_ops_playbookकार्य का उपयोग करें, या MCP को स्थानीय मोड में चलाएं। - भुगतान लिंक
http://localhostदिखाते हैं: मानव को सार्वजनिक डोमेन से सेटिंग्स → साइट URL सहेजना चाहिए (payram_runbookकार्यset_site_url)। - डॉक्स टूल कहता है फ़ाइल गायब है: सत्यापित करें कि आपका स्थानीय
docs/payram-docs-live/ट्री में अनुरोधित मार्कडाउन है (get_payram_doc_by_id..के साथ पथ अस्वीकार करता है)। - सर्वर शुरू नहीं होगा: Node 20+ सुनिश्चित करें और
yarn installचलाएं। स्थानीय मोड में गैर-लूपबैकHOSTऔरPAYRAM_*क्रेडेंशियल सेट के साथ, सर्वरMCP_SERVER_TOKENसेट होने तक शुरू करने से इनकार करता है (देखें स्थानीय मोड)।
किसी और चीज़ के लिए, src/utils/logger.ts से उत्सर्जित संरचित लॉग का निरीक्षण करें (LOG_LEVEL=debug सेट करें) और पुनरुत्पादन विवरण के साथ एक मुद्दा/PR खोलें।