payments
PayPal MCP, CLI, and Lua Integration for AI Agents
PayPal integration docs for AI agents: MCP gateway setup, PayPal CLI commands, Lua API reference, credentials, and function schemas.
7 functions 6 read 1 write Bearer token auth
PayPal for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Machine-Readable Metadata
- integration_slug
paypal- route_slug
paypal- package
paypal- auth_strategy
bearer_tokenBearer token- cli_setup_supported
true- cli_runtime_supported
true- mcp_gateway_supported
true- lua_supported
true- supports_multi_account
true
Quick Links
Lua APIAgent-facing namespace and function reference. PayPal CLIHeadless setup and direct function calls. PayPal MCPMCP gateway setup for external clients. Submit feedbackReport missing tools, auth problems, wrong docs, or runtime issues. ContributeAdd tools or improve metadata in the integrations repo.
PayPal MCP Client Matrix
Use these pages when a specific agent client or framework needs copy-pasteable MCP setup for PayPal.
Claude Code PayPal MCP setup for Claude Code. Cursor PayPal MCP setup for Cursor. Codex PayPal MCP setup for Codex. OpenAI Agents PayPal MCP setup for OpenAI Agents SDK. Claude Agent SDK PayPal MCP setup for Claude Agent SDK. Vercel AI SDK PayPal MCP setup for Vercel AI SDK. LangChain PayPal MCP setup for LangChain. LangGraph PayPal MCP setup for LangGraph. CrewAI PayPal MCP setup for CrewAI. MCP clients PayPal MCP setup for Generic MCP Clients.
PayPal CLI Matrix
Use these pages for direct PayPal CLI workflows in scripts, CI, cron, and agent wrappers.
CI PayPal CLI for CI. Cron Jobs PayPal CLI for cron jobs. Shell Scripts PayPal CLI for shell scripts. Headless Automation PayPal CLI for headless automation. Coding Agents PayPal CLI for coding agents.
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
paypal.paypal_list_orders | Read read | 5 | List PayPal checkout orders. Returns order IDs, statuses, and amounts. Use filters to narrow results by status or date range. |
paypal.paypal_get_order | Read read | 1 | Get details of a specific PayPal checkout order by its order ID. Returns full order information including status, payer details, and line items. |
paypal.paypal_create_order | Write write | 4 | Create a new PayPal checkout order. Specify the intent, purchase units with amounts, and optional payer details. Returns the created order with approval links. |
paypal.paypal_list_payments | Read read | 6 | List PayPal payments. Returns payment IDs, states, amounts, and transaction details. Use filters to narrow results by count or date range. |
paypal.paypal_get_payment | Read read | 1 | Get details of a specific PayPal payment by its payment ID. Returns full payment information including state, amount, payer details, and transactions. |
paypal.paypal_list_invoices | Read read | 4 | List PayPal invoices. Returns invoice IDs, numbers, statuses, amounts, and recipient details. Use pagination parameters to navigate through results. |
paypal.paypal_get_current_user | Read read | 1 | Get the authenticated PayPal user's profile information. Returns the user's name, email, and other account details. |