> This page is for Workforce. > 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.