> This page is for Agent Handler.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# PayPal

**Authentication:** API credentials. See [Magic Link](/merge-agent-handler/features/magic-link) for the runtime auth flow.

## Sample use cases

* List transactions in the last 7 days over \$1,000, sorted by amount.
* Issue a refund for transaction `TXN-12345` for the full amount.
* Pull total volume by currency for last month.

## Available Tools

#### list\_disputes

List PayPal disputes with optional filters for state and start time. Returns paginated results.

#### get\_dispute

Get full details of a PayPal dispute by ID including transactions, messages, and evidence.

#### accept\_dispute\_claim

Accept a PayPal dispute claim and issue a refund to the buyer.

#### escalate\_dispute

Escalate a PayPal dispute to a claim for PayPal to investigate and decide.

#### provide\_dispute\_evidence

Provide evidence for a PayPal dispute such as tracking info or proof of delivery.

#### acknowledge\_return\_item

Acknowledge receipt of a returned item in a PayPal dispute.

#### send\_dispute\_message

Send a message to the buyer or PayPal about a dispute.

#### make\_dispute\_offer

Make an offer to resolve a PayPal dispute with refund, return, or replacement.

#### create\_invoice

Create a draft PayPal invoice. Requires detail with currency\_code. Send separately.

#### list\_invoices

List PayPal invoices with pagination. Returns invoice summaries.

#### get\_invoice

Get details of a PayPal invoice by ID including items, amounts, and payment status.

#### update\_invoice

Fully update a PayPal draft invoice. Cannot update sent invoices.

#### delete\_invoice

Delete a PayPal draft invoice. Cannot delete sent or paid invoices.

#### send\_invoice

Send a PayPal draft invoice to recipients via email. Changes status to SENT.

#### cancel\_invoice

Cancel a sent PayPal invoice. Notifies recipient of cancellation.

#### record\_invoice\_payment

Record an external payment on a PayPal invoice (e.g., cash, check, bank transfer).

#### generate\_invoice\_number

Generate the next invoice number in PayPal's sequence.

#### create\_order

Create a PayPal order with CAPTURE or AUTHORIZE intent. Include purchase\_units with amount and items.

#### get\_order

Get details of a PayPal order by ID including status, purchase units, and payment info.

#### update\_order

Update a PayPal order's purchase\_units using JSON Patch operations before capture.

#### capture\_order

Capture payment for an approved PayPal order. Use after buyer approves the order.

#### authorize\_order

Authorize payment for an approved PayPal order. Places a hold on buyer's funds.

#### confirm\_order

Confirm a PayPal order with a specific payment source before capture or authorization.

#### get\_authorized\_payment

Get details of an authorized PayPal payment by authorization ID.

#### capture\_authorized\_payment

Capture funds from an authorized PayPal payment. Can capture full or partial amount.

#### void\_authorized\_payment

Void an authorized PayPal payment to release the hold on buyer's funds.

#### reauthorize\_payment

Reauthorize a PayPal payment to extend the authorization period.

#### get\_captured\_payment

Get details of a captured PayPal payment by capture ID.

#### refund\_captured\_payment

Refund a captured PayPal payment. Can refund full or partial amount.

#### get\_refund

Get details of a PayPal refund by refund ID.

#### create\_payout

Create a PayPal payout batch to send money to multiple recipients via email, phone, or PayPal ID.

#### get\_payout\_batch

Get details of a PayPal payout batch by ID including status and all payout items.

#### get\_payout\_item

Get details of a specific PayPal payout item by ID including transaction status.

#### cancel\_payout\_item

Cancel an unclaimed PayPal payout item. Only works for items in UNCLAIMED status.

#### create\_product

Create a catalog product in PayPal. Products are required before creating subscription plans.

#### list\_products

List catalog products in PayPal with pagination. Use to find product IDs for plans.

#### get\_product

Get details of a PayPal catalog product by ID.

#### update\_product

Update a PayPal catalog product using JSON Patch operations.

#### create\_plan

Create a billing plan for subscriptions. Requires a product\_id. Use list\_products first.

#### list\_plans

List billing plans in PayPal with optional product\_id filter. Returns paginated results.

#### get\_plan

Get details of a PayPal billing plan by ID including billing cycles and pricing.

#### update\_plan

Update a PayPal billing plan using JSON Patch operations.

#### activate\_plan

Activate an inactive PayPal billing plan to make it available for subscriptions.

#### deactivate\_plan

Deactivate a PayPal billing plan. Existing subscriptions continue but no new ones allowed.

#### update\_plan\_pricing

Update pricing for a PayPal billing plan. Changes apply to new billing cycles.

#### create\_subscription

Create a PayPal subscription for recurring payments. Requires a plan\_id. Use list\_plans first.

#### get\_subscription

Get details of a PayPal subscription by ID including billing info and status.

#### update\_subscription

Update a PayPal subscription using JSON Patch operations.

#### activate\_subscription

Activate a suspended PayPal subscription to resume billing.

#### suspend\_subscription

Suspend a PayPal subscription to temporarily stop billing. Can be reactivated later.

#### cancel\_subscription

Cancel a PayPal subscription permanently. Stops all future billing.

#### capture\_subscription\_payment

Capture outstanding balance on a PayPal subscription.

#### revise\_subscription

Revise a PayPal subscription to change plan, quantity, or shipping. Requires buyer approval.

#### list\_subscription\_transactions

List transactions for a PayPal subscription within a date range.

#### create\_webhook

Create a PayPal webhook to receive event notifications at your URL. Max 10 per app.

#### list\_webhooks

List all PayPal webhooks for your application.

#### get\_webhook

Get details of a PayPal webhook by ID including URL and subscribed event types.

#### update\_webhook

Update a PayPal webhook URL or event subscriptions using JSON Patch operations.

#### delete\_webhook

Delete a PayPal webhook. Stops all event notifications to that URL.

#### list\_webhook\_event\_types

List all available PayPal webhook event types you can subscribe to.

#### verify\_webhook\_signature

Verify a PayPal webhook signature to ensure the event is authentic.