Integrations

PayPal's agent toolkit supports OpenAI’s Agents SDK , Vercel’s AI SDK, and Model Context Protocol (MCP) . It works with LLM providers that support function calling and is compatible with TypeScript and Python.

Set up your environment

To prepare for an integration, set up your environment first.

Download and install Node.js version 18 or later from the official Node.js website.
Run the command npm install @paypal/agent-toolkit to install the agent toolkit, or download the package from the GitHub repo .

You'll also need your PayPal account's client ID and secret from PayPal Developer Dashboard to configure this library.

Set up an integration

See the corresponding topic for your AI platform in this guide.

For information about setting up the front end for testing any of these integrations, see the agent toolkit quickstart guide .

Complete the following steps to integrate PayPal's agent toolkit with OpenAI's Agents SDK. The agent toolkit works with Agents SDK, whichpasses it as a list of tools.

Import PayPal’s agent toolkit into your code.

Update your clientId and clientSecret with the values from PayPal Developer Dashboard.

from paypal_agent_toolkit.openai.toolkit import PayPalToolkit
from paypal_agent_toolkit.common.configuration import Configuration, Context

configuration = Configuration(
    actions={
        "orders": {
            "create": True,
            "get": True,
            "capture": True,
        }
    },
    context=Context(
        sandbox=True
    )
)

# Initialize toolkit
toolkit = PayPalToolkit(client_id=PAYPAL_CLIENT_ID, secret=PAYPAL_SECRET, configuration = configuration)

You can use the agent toolkit's functions and other tools as your integration requires.

from agents import Agent

tools = toolkit.get_tools()

agent = Agent(
    name="PayPal Assistant",
    instructions="""
    You're a helpful assistant specialized in managing PayPal transactions:
    - To create orders, invoke create_order.
    - After approval by user, invoke capture_order.
    - To check an order status, invoke get_order_status.
    """,
    tools=tools
)

Test your integration.

Complete the following steps to integrate PayPal's agent toolkit with Vercel's AI SDK. The agent toolkit works with Vercel's AI SDK, which passes it as a list of tools.

Import PayPal’s agent toolkit into your code.

Update your clientId and clientSecret with the values from PayPal Developer Dashboard.

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,
        list: true,
        send: true,
        sendReminder: true,
        cancel: true,
        generateQRC: 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 },
    },
  },
});

You can use the agent toolkit's functions and other tools as your integration requires.

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

Test your integration.

Model Context Protocol (MCP) supports managing and passing relevant information to modelswith appropriate context, so they operate properly within a given scope. Using this technology, PayPal developed an MCP server to enable merchants to use natural language with their favorite MCP client.

To install the MCP server in a local configuration:

If you haven't already done so, visit the Node.js official website to download and install it. Be sure that you are running Node.js v18 or later.

Update the configuration file in your favorite MCP client:

Open the MCP client.
In the configuration settings for the client, locate the external tools or connectors configuration section, and add the PayPal connector configuration that follows this procedure. In Claude, for example, you add this to ~/Claude/claude_desktop_config.json.
In the new entry, replace YOUR_PAYPAL_ACCESS_TOKEN with your actual PayPal access token. Alternatively, you can set the PAYPAL_ACCESS_TOKEN as an environment variable. You also can pass it as an argument using --access-token in args.
Set the PAYPAL_ENVIRONMENT to SANDBOX for testing or PRODUCTION for your production environment.

Test your integration.

Quit and restart the MCP client to apply your changes.
Ask the MCP client to perform one of the supported tasks. For example, ask the MCP client to list your PayPal invoices for the last month.

{
   "mcpServers": {
     "paypal": {
       "command": "npx",
       "args": [
         "-y",
         "@paypal/mcp",
         "--tools=all"
       ],
       "env": {
         "PAYPAL_ACCESS_TOKEN": "YOUR_PAYPAL_ACCESS_TOKEN",
         "PAYPAL_ENVIRONMENT": "SANDBOX"
       }
     }
   }
}

If your test effort doesn't produce the results you expect, try the ideas here .

Complete the following steps to integrate the agent toolkit from PayPal with LangChain. The agent toolkit works with LangChain, which passes it as a list of tools.

Import PayPal’s agent toolkit into your code.

Update your clientId and clientSecret with the values from PayPal Developer Dashboard.

from langchain.agents import initialize_agent, AgentType
from langchain_openai import ChatOpenAI 
from paypal_agent_toolkit.langchain.toolkit import PayPalToolkit

# Initialize Langchain Toolkit
toolkit = PayPalToolkit(client_id=PAYPAL_CLIENT_ID, secret=PAYPAL_SECRET, configuration = configuration)
tools = toolkit.get_tools()

# Setup LangChain Agent
agent = initialize_agent(
    tools=tools,
    llm=llm,
    agent=AgentType.OPENAI_FUNCTIONS,
    verbose=True
)

prompt = "Create an PayPal order for $50 for Premium News service."
# Run the agent with the defined prompt
result = agent.run(prompt)

Test your integration.

Complete the following steps to integrate the agent toolkit from PayPal with CrewAI. The agent toolkit works with CrewAI, whichpasses itas a list of tools.

Import PayPal’s agent toolkit into your code.

Update your clientId and clientSecret with the values from PayPal Developer Dashboard.

from crewai import Agent, Crew, Task
from paypal_agent_toolkit.crewai.toolkit import PayPalToolkit

# Setup PayPal CrewAI Toolkit
toolkit = PayPalToolkit(client_id=PAYPAL_CLIENT_ID, secret=PAYPAL_SECRET, configuration = configuration)
tools = toolkit.get_tools()

# Define an agent specialized in PayPal transactions
agent = Agent(
    role="PayPal Assistant",
    goal="Help users create and manage PayPal transactions",
    backstory="You are a finance assistant skilled in PayPal operations.",
    tools=toolkit.get_tools(),
    allow_delegation=False
)

# Define a CrewAI Task to create a PayPal order
task = Task(
    description="Create an PayPal order for $50 for Premium News service.",
    expected_output="A PayPal order ID",
    agent=agent
)

# Assemble Crew with defined agent and task
crew = Crew(agents=[agent], tasks=[task], verbose=True,
    planning=True,)

Test your integration.

PreviousQuickstart NextAvailable tools

Was this helpful?

Good evening

hashtagSet up your environment

hashtagSet up an integration

Set up your environment

Set up an integration