PayPal Integration

The PayPal integration provides access to manage PayPal orders, captures, refunds, invoices, products, plans, and subscriptions through the Integrate MCP server.

Installation

The PayPal integration is included with the SDK:

import { paypalIntegration } from "integrate-sdk/server";

Setup

Add PayPal to your server configuration. Provide credentials via environment variables or integration config:

import { createMCPServer, paypalIntegration } from "integrate-sdk/server";
 
export const { client: serverClient } = createMCPServer({
  apiKey: process.env.INTEGRATE_API_KEY,
  integrations: [
    paypalIntegration({
      // See configuration options below
    }),
  ],
});

Client-Side Usage

import { client } from "integrate-sdk";
 
const result = await client.paypal.createOrder({
  order_json: "value",
});
 
console.log(result);

Environment Variables

• PAYPAL_API_KEY (when supported by this integration)

Configuration Options

export interface PayPalIntegrationConfig {
  clientId?: string;

Tools

paypal_create_order

Create order

export interface PaypalCreateOrderParams { order_json: string }

paypal_get_order

Get order

export interface PaypalGetOrderParams { order_id: string }

paypal_capture_order

Capture order

export interface PaypalCaptureOrderParams { order_id: string;

paypal_get_capture

Get capture

export interface PaypalGetCaptureParams { capture_id: string }

paypal_refund_capture

Refund capture

export interface PaypalRefundCaptureParams { capture_id: string;

paypal_get_refund

Get refund

export interface PaypalGetRefundParams { refund_id: string }

paypal_list_invoices

List invoices

export interface PaypalListInvoicesParams { page?: number;

paypal_get_invoice

Get invoice

export interface PaypalGetInvoiceParams { invoice_id: string }

paypal_create_invoice

Create invoice

export interface PaypalCreateInvoiceParams { invoice_json: string }

paypal_send_invoice

Send invoice

export interface PaypalSendInvoiceParams { invoice_id: string;

paypal_list_products

List products

export interface PaypalListProductsParams { page_size?: number;

paypal_create_product

Create product

export interface PaypalCreateProductParams { product_json: string }

paypal_list_plans

List plans

export interface PaypalListPlansParams { product_id?: string;

paypal_create_plan

Create plan

export interface PaypalCreatePlanParams { plan_json: string }

paypal_get_subscription

Get subscription

export interface PaypalGetSubscriptionParams { subscription_id: string }

paypal_cancel_subscription

Cancel subscription

export interface PaypalCancelSubscriptionParams { subscription_id: string;

Notes

• Category: Finance
• Authentication mode: API key