PayPal

npx add-mcp 'https://mcp.paypal.com/mcp'

PayPal Agent Toolkit

PayPal Agent Toolkit लोकप्रिय एजेंट फ्रेमवर्क जैसे OpenAI's Agent SDK, LangChain, Vercel's AI SDK, और Model Context Protocol (MCP) को फ़ंक्शन कॉलिंग के माध्यम से PayPal APIs के साथ एकीकृत करने में सक्षम बनाता है। इसमें TypeScript के लिए समर्थन शामिल है और यह PayPal APIs और PayPal SDKs के ऊपर बनाया गया है।

उपलब्ध उपकरण

PayPal Agent toolkit निम्नलिखित उपकरण प्रदान करता है:

इनवॉइस

• create_invoice: PayPal सिस्टम में एक नया इनवॉइस बनाएं, जिसमें प्राप्तकर्ता की बिलिंग विवरण, लाइन आइटम, एक इनवॉइस नोट, एक कस्टम रंग थीम, एक वैकल्पिक शिपिंग लागत, और PAY_BY_BANK को भुगतान विधि के रूप में सक्षम करने का विकल्प शामिल है

• list_invoices: वैकल्पिक पेजिनेशन और फ़िल्टरिंग के साथ इनवॉइस सूचीबद्ध करें

• get_invoice: किसी विशिष्ट इनवॉइस का विवरण प्राप्त करें

• send_invoice: प्राप्तकर्ताओं को एक इनवॉइस भेजें

• send_invoice_reminder: मौजूदा इनवॉइस के लिए एक अनुस्मारक भेजें

• cancel_sent_invoice: भेजे गए इनवॉइस को रद्द करें

• generate_invoice_qr_code: इनवॉइस के लिए एक QR कोड उत्पन्न करें

• delete_invoice: ड्राफ्ट या निर्धारित इनवॉइस को स्थायी रूप से हटाएं

• generate_invoice_number: व्यापारी के लिए उपलब्ध अगला इनवॉइस नंबर उत्पन्न करें

• search_invoicing: इनवॉइस या आवर्ती इनवॉइस श्रृंखला खोजें

• update_invoicing: मौजूदा इनवॉइस या आवर्ती इनवॉइस श्रृंखला अपडेट करें (पूर्ण-प्रतिस्थापन)

• cancel_invoice_auto_reminder: इनवॉइस के लिए सभी निर्धारित स्वचालित अनुस्मारक रद्द करें

• record_payment_for_invoice: इनवॉइस के विरुद्ध बाहरी या मैन्युअल भुगतान दर्ज करें

• record_refund_for_invoice: इनवॉइस के विरुद्ध रिफंड दर्ज करें

• create_conditional_rules_for_invoice: इनवॉइस के लिए सशर्त नियम बनाएं, जैसे जल्दी भुगतान छूट या स्वचालित रद्दीकरण तिथि

• create_recurring_series: एक आवर्ती इनवॉइस श्रृंखला बनाएं जो स्वचालित रूप से एक शेड्यूल पर इनवॉइस उत्पन्न और भेजती है

• activate_recurring_series: एक ड्राफ्ट आवर्ती इनवॉइस श्रृंखला सक्रिय करें

• get_recurring_series: किसी विशिष्ट आवर्ती इनवॉइस श्रृंखला का विवरण प्राप्त करें

• cancel_recurring_series: एक सक्रिय आवर्ती इनवॉइस श्रृंखला रद्द करें

• delete_recurring_series: एक ड्राफ्ट आवर्ती इनवॉइस श्रृंखला हटाएं

भुगतान

• create_order: प्रदान किए गए विवरण के आधार पर PayPal सिस्टम में एक ऑर्डर बनाएं
• get_order: एक ऑर्डर का विवरण प्राप्त करें
• pay_order: एक अधिकृत ऑर्डर के लिए भुगतान संसाधित करें
• create_refund: कैप्चर किए गए भुगतान के लिए रिफंड संसाधित करें।
• get_refund: किसी विशिष्ट रिफंड का विवरण प्राप्त करें।

विवाद प्रबंधन

• list_disputes: सभी खुले विवादों का सारांश प्राप्त करें
• get_dispute: किसी विशिष्ट विवाद की विस्तृत जानकारी प्राप्त करें
• accept_dispute_claim: एक विवाद दावा स्वीकार करें

शिपमेंट ट्रैकिंग

• create_shipment_tracking: एक शिपमेंट ट्रैकिंग रिकॉर्ड बनाएं
• get_shipment_tracking: शिपमेंट ट्रैकिंग जानकारी प्राप्त करें
• update_shipment_tracking: शिपमेंट ट्रैकिंग जानकारी अपडेट करें

कैटलॉग प्रबंधन

• create_product: PayPal कैटलॉग में एक नया उत्पाद बनाएं
• list_products: वैकल्पिक पेजिनेशन और फ़िल्टरिंग के साथ उत्पाद सूचीबद्ध करें
• show_product_details: किसी विशिष्ट उत्पाद का विवरण प्राप्त करें

सदस्यता प्रबंधन

• create_subscription_plan: एक नई सदस्यता योजना बनाएं
• list_subscription_plans: सदस्यता योजनाएं सूचीबद्ध करें
• show_subscription_plan_details: किसी विशिष्ट सदस्यता योजना का विवरण प्राप्त करें
• create_subscription: एक नई सदस्यता बनाएं
• show_subscription_details: किसी विशिष्ट सदस्यता का विवरण प्राप्त करें
• update_subscription: एक मौजूदा सदस्यता अपडेट करें
• cancel_subscription: एक सक्रिय सदस्यता रद्द करें

रिपोर्टिंग और अंतर्दृष्टि

• list_transactions: वैकल्पिक पेजिनेशन और फ़िल्टरिंग के साथ लेनदेन सूचीबद्ध करें
• get_merchant_insights: एक व्यापारी के लिए व्यावसायिक खुफिया मेट्रिक्स और विश्लेषण प्राप्त करें

TypeScript

स्थापना

आपको इस स्रोत कोड की आवश्यकता नहीं है जब तक कि आप पैकेज को संशोधित नहीं करना चाहते। यदि आप केवल पैकेज का उपयोग करना चाहते हैं तो चलाएं:

npm install @paypal/agent-toolkit

आवश्यकताएं

• Node 18+

उपयोग

लाइब्रेरी को आपके खाते के क्लाइंट आईडी और सीक्रेट के साथ कॉन्फ़िगर करने की आवश्यकता है जो आपके PayPal Developer Dashboard में उपलब्ध है।

टूलकिट Vercel's AI SDK के साथ काम करता है और इसे उपकरणों की सूची के रूप में पारित किया जा सकता है। अधिक विवरण के लिए, हमारे उदाहरण देखें

import { PayPalAgentToolkit } from '@paypal/agent-toolkit/ai-sdk';
const paypalToolkit = new PayPalAgentToolkit({
  clientId: process.env.PAYPAL_CLIENT_ID,
  clientSecret: process.env.PAYPAL_CLIENT_SECRET,
  configuration: {
    actions: {
      invoices: {
        create: true,
        createRecurringSeries: true,
        list: true,
        send: true,
        sendReminder: true,
        cancel: true,
        delete: true,
        generateQRC: true,
        generateInvoiceNumber: true,
        search: true,
        update: true,
        cancelReminders: true,
        recordPayment: true,
        recordRefund: true,
        createConditionalRules: true,
      },
      products: { create: true, list: true, update: true },
      subscriptionPlans: { create: true, list: true, show: true },
      shipment: { create: true, show: true, cancel: true },
      orders: { create: true, get: true },
      disputes: { list: true, get: true },
    },
  },
});

सैंडबॉक्स मोड का उपयोग करने के लिए, अपने कॉन्फ़िगरेशन में संदर्भ जोड़ें।

configuration: {
  context: {
    sandbox: true,
  }
}

वर्कफ़्लो प्रारंभ करना

import { PayPalWorkflows, ALL_TOOLS_ENABLED } from '@paypal/agent-toolkit/ai-sdk';
const paypalWorkflows = new PayPalWorkflows({
  clientId: process.env.PAYPAL_CLIENT_ID,
  clientSecret: process.env.PAYPAL_CLIENT_SECRET,
  configuration: {
    actions: ALL_TOOLS_ENABLED,
  },
});

उपयोग

टूलकिट का उपयोग करना

const llm: LanguageModelV1 = getModel(); // The model to be used with ai-sdk
const { text: response } = await generateText({
  model: llm,
  tools: paypalToolkit.getTools(),
  maxSteps: 10,
  prompt: `Create an order for $50 for custom handcrafted item and get the payment link.`,
});

पर्यावरण चर

निम्नलिखित पर्यावरण चर का उपयोग किया जा सकता है:

• PAYPAL_ACCESS_TOKEN: आपका PayPal एक्सेस टोकन
• PAYPAL_ENVIRONMENT: सैंडबॉक्स मोड के लिए SANDBOX पर सेट करें, उत्पादन के लिए PRODUCTION (डिफ़ॉल्ट रूप से SANDBOX मोड)

यह मार्गदर्शिका PayPal API एकीकरण के लिए एक्सेस टोकन उत्पन्न करने का तरीका बताती है, जिसमें आपका क्लाइंट आईडी और क्लाइंट सीक्रेट कैसे खोजें शामिल है।

पूर्वापेक्षाएँ

• PayPal डेवलपर खाता (सैंडबॉक्स के लिए)
• PayPal व्यावसायिक खाता (उत्पादन के लिए)

अपना क्लाइंट आईडी और क्लाइंट सीक्रेट खोजना

1. PayPal डेवलपर खाता बनाएं:

   • PayPal Developer Dashboard पर जाएं
   • अपने PayPal क्रेडेंशियल्स के साथ साइन अप करें या लॉग इन करें

2. अपने क्रेडेंशियल्स तक पहुंचें:

   • डेवलपर डैशबोर्ड में, मेनू में Apps & Credentials पर क्लिक करें
   • अपनी आवश्यकताओं के आधार पर Sandbox और Live मोड के बीच स्विच करें

3. ऐप बनाएं या देखें:

   • नया ऐप बनाने के लिए, Create App पर क्लिक करें
   • अपने ऐप को एक नाम दें और उससे संबद्ध करने के लिए एक व्यावसायिक खाता चुनें
   • मौजूदा ऐप्स के लिए, विवरण देखने के लिए ऐप नाम पर क्लिक करें

4. क्रेडेंशियल्स प्राप्त करें:

   • एक बार आपका ऐप बनाया या चुना जाता है, तो आपको अपने साथ एक स्क्रीन दिखाई देगी:
     • Client ID: आपके ऐप के लिए एक सार्वजनिक पहचानकर्ता
     • Client Secret: एक निजी कुंजी ("Show" पर क्लिक करने के बाद दिखाई जाती है)
   • इन क्रेडेंशियल्स को सुरक्षित रूप से सहेजें क्योंकि एक्सेस टोकन उत्पन्न करने के लिए इनकी आवश्यकता होती है

एक्सेस टोकन उत्पन्न करना

cURL का उपयोग करना

curl -v https://api-m.sandbox.paypal.com/v1/oauth2/token \\
  -H \"Accept: application/json\" \\
  -H \"Accept-Language: en_US\" \\
  -u \"CLIENT_ID:CLIENT_SECRET\" \\
  -d \"grant_type=client_credentials\"

CLIENT_ID और CLIENT_SECRET को अपने वास्तविक क्रेडेंशियल्स से बदलें। उत्पादन के लिए, सैंडबॉक्स URL के बजाय https://api-m.paypal.com का उपयोग करें।

Postman का उपयोग करना

1. https://api-m.sandbox.paypal.com/v1/oauth2/token पर एक नया अनुरोध बनाएं
2. विधि को POST पर सेट करें
3. Authorization के तहत, Basic Auth चुनें और अपना क्लाइंट आईडी और क्लाइंट सीक्रेट दर्ज करें
4. Body के तहत, x-www-form-urlencoded चुनें और मान client_credentials के साथ एक कुंजी grant_type जोड़ें
5. अनुरोध भेजें

प्रतिक्रिया

एक सफल प्रतिक्रिया इस तरह दिखेगी:

{
  "scope": "...",
  "access_token": "Your Access Token",
  "token_type": "Bearer",
  "app_id": "APP-80W284485P519543T",
  "expires_in": 32400,
  "nonce": "..."
}

अपने Claude Desktop एकीकरण में उपयोग के लिए access_token मान कॉपी करें।

टोकन विवरण

• सैंडबॉक्स टोकन: 3-8 घंटे के लिए मान्य
• उत्पादन टोकन: 8 घंटे के लिए मान्य
• समाप्ति से पहले टोकन रीफ्रेश लॉजिक लागू करने की अनुशंसा की जाती है

Claude Desktop के साथ टोकन का उपयोग करना

एक बार आपके पास अपना एक्सेस टोकन हो, तो अपने Claude Desktop कनेक्टर कॉन्फ़िगरेशन में PAYPAL_ACCESS_TOKEN मान अपडेट करें:

{
  "env": {
    "PAYPAL_ACCESS_TOKEN": "YOUR_NEW_ACCESS_TOKEN",
    "PAYPAL_ENVIRONMENT": "SANDBOX"
  }
}

सर्वोत्तम अभ्यास

1. क्लाइंट आईडी और क्लाइंट सीक्रेट को सुरक्षित रूप से संग्रहीत करें
2. टोकन समाप्ति को संभालने के लिए टोकन रीफ्रेश लॉजिक लागू करें
3. पर्यावरण-विशिष्ट टोकन का उपयोग करें (परीक्षण के लिए सैंडबॉक्स, वास्तविक लेनदेन के लिए उत्पादन)
4. एप्लिकेशन कोड में टोकन हार्डकोड करने से बचें

अस्वीकरण

AI-जनित सामग्री गलत या अधूरी हो सकती है। उपयोगकर्ता किसी भी जानकारी पर भरोसा करने से पहले स्वतंत्र रूप से सत्यापित करने के लिए जिम्मेदार हैं। PayPal आउटपुट सटीकता के संबंध में कोई गारंटी नहीं देता है और इसके उपयोग से उत्पन्न किसी भी निर्णय, कार्रवाई या परिणाम के लिए उत्तरदायी नहीं है।