Glama
Sign In

PayPal MCP Server

by arbuthnot-eth
Verified
GitHub
TypeScript
Apache 2.0
RedditDiscord
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Used for visualizing the architecture of the PayPal MCP server through diagrams in the documentation.

  • Provides the runtime environment for the MCP server, supporting the execution of the PayPal integration services.

  • Enables comprehensive interaction with PayPal's payment processing systems, including orders management, payment processing, invoicing, subscription management, dispute resolution, product catalog management, payouts, and user identity verification.

PayPal MCP Server

A Model Context Protocol (MCP) server that provides comprehensive integration with PayPal's APIs. This server enables seamless interaction with PayPal's payment processing, invoicing, subscription management, and business operations through a standardized interface.

Features

Payment Processing

  • Orders Management: Create, update, and track orders
  • Payment Processing: Process payments with various methods
  • Payment Tokens: Create and manage payment tokens for future use
  • Dispute Management: Handle payment disputes and resolutions

Business Operations

  • Product Management: Create and manage product catalogs
  • Invoicing: Generate and send professional invoices
  • Payouts: Process batch payouts to multiple recipients
  • Subscription Management: Create and manage recurring billing

User Management

  • Identity Verification: Verify user identities
  • User Information: Retrieve and manage user data
  • Web Profile Management: Customize checkout experiences

Architecture

Installation

Prerequisites

  • Node.js 16.x or later
  • PayPal Developer Account with API credentials

Manual Installation

  1. Clone the repository
    git clone https://github.com/arbuthnot-eth/PayPal-MCP.git cd PayPal-MCP
  2. Install dependencies
    npm install
  3. Build the project
    npm run build
  4. Configure PayPal credentials in your MCP settings file:
    { "mcpServers": { "paypal": { "command": "node", "args": ["path/to/paypal-mcp/build/index.js"], "env": { "PAYPAL_CLIENT_ID": "your_client_id", "PAYPAL_CLIENT_SECRET": "your_client_secret", "PAYPAL_ENVIRONMENT": "sandbox" // or "live" }, "disabled": false, "autoApprove": [] } } }

Available Tools

Payment Operations

create_payment_token

Create a payment token for future use.

{ customer: { id: string; email_address?: string; }; payment_source: { card?: { name: string; number: string; expiry: string; security_code: string; }; paypal?: { email_address: string; }; }; }

create_order

Create a new order in PayPal.

{ intent: 'CAPTURE' | 'AUTHORIZE'; purchase_units: Array<{ amount: { currency_code: string; value: string; }; description?: string; reference_id?: string; items?: Array<{ name: string; quantity: string; unit_amount: { currency_code: string; value: string; }; }>; }>; application_context?: { brand_name?: string; shipping_preference?: 'GET_FROM_FILE' | 'NO_SHIPPING' | 'SET_PROVIDED_ADDRESS'; user_action?: 'CONTINUE' | 'PAY_NOW'; }; }

capture_order

Capture payment for an authorized order.

{ order_id: string; payment_source?: { token?: { id: string; type: string; }; }; }

create_subscription

Create a subscription for recurring billing.

{ plan_id: string; subscriber: { name: { given_name: string; surname: string; }; email_address: string; }; application_context?: { brand_name?: string; shipping_preference?: 'GET_FROM_FILE' | 'NO_SHIPPING' | 'SET_PROVIDED_ADDRESS'; user_action?: 'CONTINUE' | 'SUBSCRIBE_NOW'; payment_method?: { payer_selected?: string; payee_preferred?: string; }; }; }

Business Operations

create_product

Create a new product in the catalog.

{ name: string; description: string; type: 'PHYSICAL' | 'DIGITAL' | 'SERVICE'; category: string; image_url?: string; home_url?: string; }

create_invoice

Generate a new invoice.

{ invoice_number: string; reference: string; currency_code: string; recipient_email: string; items: Array<{ name: string; quantity: string; unit_amount: { currency_code: string; value: string; }; description?: string; tax?: { name: string; percent: string; }; }>; note?: string; terms_and_conditions?: string; memo?: string; payment_term?: { term_type: 'DUE_ON_RECEIPT' | 'DUE_ON_DATE' | 'NET_10' | 'NET_15' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90'; due_date?: string; }; }

create_payout

Process a batch payout.

{ sender_batch_header: { sender_batch_id: string; email_subject?: string; recipient_type?: string; }; items: Array<{ recipient_type: string; amount: { value: string; currency: string; }; receiver: string; note?: string; }>; }

Error Handling

The server implements comprehensive error handling:

  • Input Validation: Detailed validation errors with specific messages
  • PayPal API Errors: Structured error responses with PayPal error details
  • Network Errors: Retry logic for transient network issues
  • Authentication Errors: Automatic token refresh and clear error messages
  • Rate Limiting: Backoff strategies for API rate limits

Security Considerations

  • All sensitive data is validated and sanitized
  • OAuth 2.0 authentication with PayPal
  • Secure credential management through environment variables
  • Input validation for all API parameters
  • Error messages don't expose sensitive information

Development

Building

npm run build

Running in Development Mode

npm run dev

Testing

npm test

Linting

npm run lint

Formatting

npm run format

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

License

MIT License

This server cannot be installed

-
security - not tested
A
license - permissive license
-
quality - not tested

A Model Context Protocol server that provides comprehensive integration with PayPal's APIs, enabling seamless interaction with payment processing, invoicing, subscription management, and business operations through a standardized interface.

  1. Features
    1. Payment Processing
    2. Business Operations
    3. User Management
  2. Architecture
    1. Installation
      1. Prerequisites
      2. Manual Installation
    2. Available Tools
      1. Payment Operations
      2. Business Operations
    3. Error Handling
      1. Security Considerations
        1. Development
          1. Building
          2. Running in Development Mode
          3. Testing
          4. Linting
          5. Formatting
        2. Contributing
          1. License