PayPal

PayPal MCP Server for Cloudflare Workers

Available Tools

77 tools available in the PayPal MCP server. Each tool can be called by AI assistants to perform specific actions.

paypal_delete_invoice_refund

Delete a refund record from an invoice.

Args:

invoice_id: The invoice ID
transaction_id: The refund transaction ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "invoice_id",
    "transaction_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "transaction_id": {
      "type": "string",
      "description": "Refund transaction ID"
    }
  }
}

paypal_cancel_payout_item

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

Args:

payout_item_id: The payout item ID to cancel

Returns: The cancelled payout item details.

{
  "type": "object",
  "required": [
    "payout_item_id"
  ],
  "properties": {
    "payout_item_id": {
      "type": "string",
      "description": "Payout item ID to cancel"
    }
  }
}

paypal_get_plan

Get details of a billing plan.

Args:

plan_id: The plan ID
format: Response format ('json' or 'markdown')

Returns: Plan details including billing cycles and payment preferences.

{
  "type": "object",
  "required": [
    "plan_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "plan_id": {
      "type": "string",
      "description": "Plan ID"
    }
  }
}

paypal_list_disputes

List disputes with optional filtering.

Args:

start_time: Filter disputes created after this time (ISO 8601) (optional)
disputed_transaction_id: Filter by transaction ID (optional)
page_size: Number of disputes per page (optional)
next_page_token: Token for pagination (optional)
dispute_state: Filter by state (optional)
format: Response format ('json' or 'markdown')

Returns: Paginated list of disputes.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    },
    "start_time": {
      "type": "string",
      "description": "Start time (ISO 8601)"
    },
    "next_page_token": {
      "type": "string",
      "description": "Pagination token"
    },
    "disputed_transaction_id": {
      "type": "string",
      "description": "Transaction ID"
    }
  }
}

paypal_get_dispute

Get details of a dispute.

Args:

dispute_id: The dispute ID
format: Response format ('json' or 'markdown')

Returns: Dispute details including reason, status, and messages.

{
  "type": "object",
  "required": [
    "dispute_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    }
  }
}

paypal_accept_dispute

Accept a dispute claim (liability). Refunds the disputed amount to the buyer.

Args:

dispute_id: The dispute ID to accept
note: Note about acceptance (optional)
accept_claim_reason: Reason for accepting (optional)
refund_currency_code: Currency for refund (optional)
refund_value: Refund amount (optional, defaults to disputed amount)

Returns: Updated dispute details.

{
  "type": "object",
  "required": [
    "dispute_id"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Acceptance note"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    },
    "refund_value": {
      "type": "string",
      "description": "Refund amount"
    },
    "refund_currency_code": {
      "type": "string",
      "description": "Refund currency"
    }
  }
}

paypal_send_dispute_message

Send a message to the other party in a dispute.

Args:

dispute_id: The dispute ID
message: Message content (required)

Returns: Confirmation of message sent.

{
  "type": "object",
  "required": [
    "dispute_id",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "Message content"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    }
  }
}

paypal_make_dispute_offer

Make a settlement offer to the buyer.

Args:

dispute_id: The dispute ID
note: Note about the offer (required)
offer_type: Type of offer (required)
offer_currency_code: Offer currency (required for REFUND types)
offer_value: Offer amount (required for REFUND types)

Returns: The offer details.

{
  "type": "object",
  "required": [
    "dispute_id",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Offer note"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    },
    "offer_value": {
      "type": "string",
      "description": "Offer amount"
    },
    "offer_currency_code": {
      "type": "string",
      "description": "Offer currency"
    }
  }
}

paypal_escalate_dispute

Escalate a dispute to a PayPal claim.

Args:

dispute_id: The dispute ID to escalate
note: Note about escalation (required)

Returns: Updated dispute details.

{
  "type": "object",
  "required": [
    "dispute_id",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Escalation note"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    }
  }
}

paypal_provide_dispute_evidence

Provide evidence for a dispute.

Args:

dispute_id: The dispute ID
evidence_type: Type of evidence (optional)
notes: Evidence notes (optional)
tracking_number: Tracking number if applicable (optional)
carrier_name: Carrier name if applicable (optional)

Returns: Confirmation of evidence provided.

{
  "type": "object",
  "properties": {
    "notes": {
      "type": "string",
      "description": "Evidence notes"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    },
    "carrier_name": {
      "type": "string",
      "description": "Carrier name"
    },
    "tracking_number": {
      "type": "string",
      "description": "Tracking number"
    }
  }
}

paypal_acknowledge_return_item

Acknowledge that a returned item was received.

Args:

dispute_id: The dispute ID
note: Acknowledgement note (required)
acknowledgement_type: Type of acknowledgement (required)

Returns: Updated dispute details.

{
  "type": "object",
  "required": [
    "dispute_id",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Acknowledgement note"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    }
  }
}

paypal_appeal_dispute

Appeal a resolved dispute decision.

Args:

dispute_id: The dispute ID to appeal
appeal_reason: Reason for appeal (required)
notes: Additional notes (optional)

Returns: Appeal result.

{
  "type": "object",
  "required": [
    "dispute_id",
    "appeal_reason"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Additional notes"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    },
    "appeal_reason": {
      "type": "string",
      "description": "Reason for appeal"
    }
  }
}

paypal_search_invoices

Search invoices with filters.

Args:

recipient_email: Filter by recipient email (optional)
recipient_name: Filter by recipient name (optional)
invoice_number: Filter by invoice number (optional)
status: Filter by status (optional)
reference: Filter by reference (optional)
currency_code: Filter by currency (optional)
memo: Filter by memo (optional)
page: Page number (optional)
page_size: Items per page (optional)
format: Response format

Returns: List of matching invoices.

{
  "type": "object",
  "properties": {
    "memo": {
      "type": "string",
      "description": "Memo"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "status": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Status filter"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    },
    "reference": {
      "type": "string",
      "description": "Reference"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    },
    "invoice_number": {
      "type": "string",
      "description": "Invoice number"
    },
    "recipient_name": {
      "type": "string",
      "description": "Recipient name"
    },
    "recipient_email": {
      "type": "string",
      "description": "Recipient email"
    }
  }
}

paypal_create_invoice

Create a draft invoice.

Args:

invoice_number: Custom invoice number (optional, auto-generated if not provided)
reference: Merchant reference (optional)
currency_code: Invoice currency (required)
recipient_email: Recipient's email address (required)
recipient_name: Recipient's name (optional)
items: JSON array of invoice items with format: [{"name": "Item name", "quantity": "1", "unit_amount": {"currency_code": "USD", "value": "100.00"}, "description": "optional description"}]
note: Note to recipient (optional)
terms_and_conditions: Terms and conditions (optional)
memo: Private merchant memo (optional)

Returns: The created draft invoice with ID.

{
  "type": "object",
  "required": [
    "currency_code",
    "recipient_email",
    "items"
  ],
  "properties": {
    "memo": {
      "type": "string",
      "description": "Private merchant memo"
    },
    "note": {
      "type": "string",
      "description": "Note to recipient"
    },
    "items": {
      "type": "string",
      "description": "JSON array of invoice items"
    },
    "reference": {
      "type": "string",
      "description": "Merchant reference"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    },
    "invoice_number": {
      "type": "string",
      "description": "Custom invoice number"
    },
    "recipient_name": {
      "type": "string",
      "description": "Recipient name"
    },
    "recipient_email": {
      "type": "string",
      "description": "Recipient email"
    },
    "terms_and_conditions": {
      "type": "string",
      "description": "Terms and conditions"
    }
  }
}

paypal_list_invoices

List invoices with optional filtering.

Args:

page: Page number (optional)
page_size: Items per page (optional)
format: Response format ('json' or 'markdown')

Returns: Paginated list of invoices.

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    }
  }
}

paypal_get_invoice

Get details of an invoice.

Args:

invoice_id: The invoice ID
format: Response format ('json' or 'markdown')

Returns: Invoice details including items, amounts, and status.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    }
  }
}

paypal_update_invoice

Fully update a draft invoice.

Args:

invoice_id: The invoice ID to update
invoice_data: Complete invoice JSON data to replace existing

Returns: The updated invoice.

{
  "type": "object",
  "required": [
    "invoice_id",
    "invoice_data"
  ],
  "properties": {
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "invoice_data": {
      "type": "string",
      "description": "Complete invoice JSON data"
    }
  }
}

paypal_delete_invoice

Delete a draft invoice.

Args:

invoice_id: The invoice ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID to delete"
    }
  }
}

paypal_send_invoice

Send an invoice to the recipient.

Args:

invoice_id: The invoice ID to send
subject: Email subject (optional)
note: Additional note (optional)
send_to_invoicer: Also send to invoicer (optional)
send_to_recipient: Send to recipient (default: true)
additional_recipients: JSON array of additional email addresses (optional)

Returns: Confirmation of sending.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Additional note"
    },
    "subject": {
      "type": "string",
      "description": "Email subject"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID to send"
    },
    "send_to_invoicer": {
      "type": "boolean",
      "description": "Send copy to invoicer"
    },
    "send_to_recipient": {
      "type": "boolean",
      "default": true,
      "description": "Send to recipient"
    },
    "additional_recipients": {
      "type": "string",
      "description": "JSON array of additional emails"
    }
  }
}

paypal_send_invoice_reminder

Send a reminder for an unpaid invoice.

Args:

invoice_id: The invoice ID
subject: Email subject (optional)
note: Reminder note (optional)
additional_recipients: JSON array of additional emails (optional)

Returns: Confirmation of reminder sent.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Reminder note"
    },
    "subject": {
      "type": "string",
      "description": "Email subject"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "additional_recipients": {
      "type": "string",
      "description": "JSON array of additional emails"
    }
  }
}

paypal_cancel_invoice

Cancel a sent invoice.

Args:

invoice_id: The invoice ID to cancel
subject: Cancellation email subject (optional)
note: Cancellation note (optional)
send_to_invoicer: Send cancellation to invoicer (optional)
send_to_recipient: Send cancellation to recipient (default: true)

Returns: Confirmation of cancellation.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Cancellation note"
    },
    "subject": {
      "type": "string",
      "description": "Email subject"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID to cancel"
    },
    "send_to_invoicer": {
      "type": "boolean",
      "description": "Send to invoicer"
    },
    "send_to_recipient": {
      "type": "boolean",
      "default": true,
      "description": "Send to recipient"
    }
  }
}

paypal_record_invoice_payment

Record an external payment for an invoice.

Args:

invoice_id: The invoice ID
method: Payment method (BANK_TRANSFER, CASH, CHECK, CREDIT_CARD, DEBIT_CARD, PAYPAL, WIRE_TRANSFER, OTHER)
currency_code: Payment currency
value: Payment amount
payment_date: Date of payment (optional)
note: Payment note (optional)

Returns: The payment ID.

{
  "type": "object",
  "required": [
    "invoice_id",
    "currency_code",
    "value"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Payment note"
    },
    "value": {
      "type": "string",
      "description": "Payment amount"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "payment_date": {
      "type": "string",
      "description": "Payment date"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    }
  }
}

paypal_delete_invoice_payment

Delete an external payment record from an invoice.

Args:

invoice_id: The invoice ID
transaction_id: The transaction/payment ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "invoice_id",
    "transaction_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "transaction_id": {
      "type": "string",
      "description": "Transaction ID to delete"
    }
  }
}

paypal_record_invoice_refund

Record an external refund for an invoice.

Args:

invoice_id: The invoice ID
method: Refund method
currency_code: Refund currency
value: Refund amount
refund_date: Date of refund (optional)

Returns: The refund ID.

{
  "type": "object",
  "required": [
    "invoice_id",
    "currency_code",
    "value"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "Refund amount"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "refund_date": {
      "type": "string",
      "description": "Refund date"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    }
  }
}

paypal_generate_invoice_number

Generate the next invoice number.

Returns: The next invoice number to use.

{
  "type": "object",
  "properties": {}
}

paypal_generate_invoice_qr_code

Generate a QR code for an invoice payment.

Args:

invoice_id: The invoice ID
width: QR code width in pixels (default: 500)
height: QR code height in pixels (default: 500)
action: QR code action - 'pay' or 'details' (default: pay)

Returns: Base64 encoded QR code image.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "width": {
      "type": "integer",
      "default": 500,
      "description": "QR code width"
    },
    "action": {
      "enum": [
        "pay",
        "details"
      ],
      "type": "string",
      "default": "pay",
      "description": "QR code action"
    },
    "height": {
      "type": "integer",
      "default": 500,
      "description": "QR code height"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    }
  }
}

paypal_create_order

Create a new PayPal order for payment processing.

Args:

intent: Payment intent - 'CAPTURE' for immediate capture or 'AUTHORIZE' for authorization
currency_code: ISO 4217 currency code (e.g., 'USD', 'EUR')
value: Order amount as string (e.g., '100.00')
description: Description of the purchase (optional)
reference_id: Merchant reference ID for the purchase unit (optional)
return_url: URL to redirect after payment approval (optional)
cancel_url: URL to redirect if payment cancelled (optional)

Returns: The created order with ID and approval links.

{
  "type": "object",
  "required": [
    "intent",
    "value"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "Amount value as string"
    },
    "intent": {
      "enum": [
        "CAPTURE",
        "AUTHORIZE"
      ],
      "type": "string",
      "description": "Payment intent"
    },
    "cancel_url": {
      "type": "string",
      "description": "Cancel URL"
    },
    "return_url": {
      "type": "string",
      "description": "Return URL after approval"
    },
    "description": {
      "type": "string",
      "description": "Purchase description"
    },
    "reference_id": {
      "type": "string",
      "description": "Merchant reference ID"
    },
    "currency_code": {
      "type": "string",
      "default": "USD",
      "description": "ISO 4217 currency code"
    }
  }
}

paypal_get_order

Get details of a PayPal order by ID.

Args:

order_id: The PayPal order ID
format: Response format ('json' or 'markdown')

Returns: Complete order details including status, amounts, and payment info.

{
  "type": "object",
  "required": [
    "order_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "order_id": {
      "type": "string",
      "description": "PayPal order ID"
    }
  }
}

paypal_update_order

Update a PayPal order with patch operations.

Args:

order_id: The PayPal order ID to update
op: Patch operation type
path: JSON Pointer path to update (e.g., '/purchase_units/@reference_id==\'default\'/amount')
value: New value for the path (as JSON string)

Returns: Confirmation of update.

{
  "type": "object",
  "required": [
    "order_id",
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "enum": [
        "add",
        "remove",
        "replace"
      ],
      "type": "string",
      "description": "Patch operation"
    },
    "path": {
      "type": "string",
      "description": "JSON Pointer path"
    },
    "value": {
      "type": "string",
      "description": "New value as JSON string"
    },
    "order_id": {
      "type": "string",
      "description": "PayPal order ID"
    }
  }
}

paypal_authorize_order

Authorize payment for an approved order. Use for orders with intent='AUTHORIZE'.

Args:

order_id: The PayPal order ID to authorize

Returns: The order with authorization details.

{
  "type": "object",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "type": "string",
      "description": "PayPal order ID"
    }
  }
}

paypal_capture_order

Capture payment for an approved order. Use for orders with intent='CAPTURE'.

Args:

order_id: The PayPal order ID to capture

Returns: The order with capture details.

{
  "type": "object",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "type": "string",
      "description": "PayPal order ID"
    }
  }
}

paypal_get_authorization

Get details of an authorization by ID.

Args:

authorization_id: The PayPal authorization ID
format: Response format ('json' or 'markdown')

Returns: Authorization details including status, amount, and expiration.

{
  "type": "object",
  "required": [
    "authorization_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "authorization_id": {
      "type": "string",
      "description": "PayPal authorization ID"
    }
  }
}

paypal_capture_authorization

Capture an authorized payment.

Args:

authorization_id: The authorization ID to capture
currency_code: Currency for capture amount (optional, uses auth currency if not provided)
value: Amount to capture as string (optional, captures full amount if not provided)
final_capture: Whether this is the final capture (default: true)
note_to_payer: Note to the payer (optional)
invoice_id: Merchant invoice ID (optional)

Returns: The capture details.

{
  "type": "object",
  "required": [
    "authorization_id"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "Amount to capture"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    },
    "final_capture": {
      "type": "boolean",
      "default": true,
      "description": "Is this the final capture"
    },
    "note_to_payer": {
      "type": "string",
      "description": "Note to payer"
    },
    "authorization_id": {
      "type": "string",
      "description": "Authorization ID to capture"
    }
  }
}

paypal_reauthorize

Reauthorize an authorization that is about to expire. Can only be done within 3 days of expiration.

Args:

authorization_id: The authorization ID to reauthorize
currency_code: Currency code for the reauthorization amount (optional)
value: Amount for reauthorization (optional)

Returns: The new authorization details.

{
  "type": "object",
  "required": [
    "authorization_id"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "Amount value"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    },
    "authorization_id": {
      "type": "string",
      "description": "Authorization ID to reauthorize"
    }
  }
}

paypal_void_authorization

Void an authorization. Releases the held funds back to the payer.

Args:

authorization_id: The authorization ID to void

Returns: Confirmation of void.

{
  "type": "object",
  "required": [
    "authorization_id"
  ],
  "properties": {
    "authorization_id": {
      "type": "string",
      "description": "Authorization ID to void"
    }
  }
}

paypal_get_capture

Get details of a captured payment.

Args:

capture_id: The PayPal capture ID
format: Response format ('json' or 'markdown')

Returns: Capture details including status, amount, and seller protection.

{
  "type": "object",
  "required": [
    "capture_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "capture_id": {
      "type": "string",
      "description": "PayPal capture ID"
    }
  }
}

paypal_list_plans

List billing plans with optional filtering.

Args:

product_id: Filter by product ID (optional)
page: Page number (optional)
page_size: Items per page (optional)
format: Response format ('json' or 'markdown')

Returns: Paginated list of plans.

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    },
    "product_id": {
      "type": "string",
      "description": "Filter by product ID"
    }
  }
}

paypal_refund_capture

Refund a captured payment, either partially or fully.

Args:

capture_id: The capture ID to refund
currency_code: Currency for refund amount (optional, uses capture currency if not provided)
value: Amount to refund as string (optional, refunds full amount if not provided)
note_to_payer: Note to the payer about the refund (optional)
invoice_id: Merchant invoice ID (optional)

Returns: The refund details.

{
  "type": "object",
  "required": [
    "capture_id"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "Amount to refund"
    },
    "capture_id": {
      "type": "string",
      "description": "Capture ID to refund"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    },
    "note_to_payer": {
      "type": "string",
      "description": "Note to payer"
    }
  }
}

paypal_get_refund

Get details of a refund.

Args:

refund_id: The PayPal refund ID
format: Response format ('json' or 'markdown')

Returns: Refund details including status and amount.

{
  "type": "object",
  "required": [
    "refund_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "refund_id": {
      "type": "string",
      "description": "PayPal refund ID"
    }
  }
}

paypal_create_payout

Create a batch payout to send money to multiple recipients.

Args:

sender_batch_id: Unique ID for this batch (required)
email_subject: Subject of payout email (optional)
email_message: Message in payout email (optional)
recipients: JSON array of payout items with format: [{"recipient_type": "EMAIL", "receiver": "email@example.com", "amount": {"value": "10.00", "currency": "USD"}, "note": "optional note", "sender_item_id": "unique_id"}]

Returns: The created payout batch with batch ID and status.

{
  "type": "object",
  "required": [
    "sender_batch_id",
    "recipients"
  ],
  "properties": {
    "recipients": {
      "type": "string",
      "description": "JSON array of payout items"
    },
    "email_message": {
      "type": "string",
      "description": "Email message"
    },
    "email_subject": {
      "type": "string",
      "description": "Email subject"
    },
    "sender_batch_id": {
      "type": "string",
      "description": "Unique batch ID"
    }
  }
}

paypal_get_payout_batch

Get details of a payout batch.

Args:

payout_batch_id: The payout batch ID
page: Page number for payout items (optional)
page_size: Number of items per page (optional)
format: Response format ('json' or 'markdown')

Returns: Batch details including status, amounts, and payout items.

{
  "type": "object",
  "required": [
    "payout_batch_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    },
    "payout_batch_id": {
      "type": "string",
      "description": "Payout batch ID"
    }
  }
}

paypal_get_payout_item

Get details of an individual payout item.

Args:

payout_item_id: The payout item ID
format: Response format ('json' or 'markdown')

Returns: Payout item details including status and recipient info.

{
  "type": "object",
  "required": [
    "payout_item_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "payout_item_id": {
      "type": "string",
      "description": "Payout item ID"
    }
  }
}

paypal_create_product

Create a catalog product for use with billing plans.

Args:

name: Product name (required)
type: Product type - 'PHYSICAL', 'DIGITAL', or 'SERVICE' (required)
description: Product description (optional)
category: Product category (optional, e.g., 'SOFTWARE', 'SERVICES')
image_url: Product image URL (optional)
home_url: Product home page URL (optional)

Returns: The created product with ID.

{
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Product name"
    },
    "type": {
      "enum": [
        "PHYSICAL",
        "DIGITAL",
        "SERVICE"
      ],
      "type": "string",
      "description": "Product type"
    },
    "category": {
      "type": "string",
      "description": "Product category"
    },
    "home_url": {
      "type": "string",
      "description": "Product home page URL"
    },
    "image_url": {
      "type": "string",
      "description": "Product image URL"
    },
    "description": {
      "type": "string",
      "description": "Product description"
    }
  }
}

paypal_list_products

List catalog products.

Args:

page: Page number (optional)
page_size: Items per page (optional)
format: Response format ('json' or 'markdown')

Returns: Paginated list of products.

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    }
  }
}

paypal_get_product

Get details of a catalog product.

Args:

product_id: The product ID
format: Response format ('json' or 'markdown')

Returns: Product details including name, type, and description.

{
  "type": "object",
  "required": [
    "product_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "product_id": {
      "type": "string",
      "description": "Product ID"
    }
  }
}

paypal_update_product

Update a catalog product with patch operations.

Args:

product_id: The product ID to update
op: Patch operation type
path: JSON Pointer path to update (e.g., '/description')
value: New value as JSON string

Returns: Confirmation of update.

{
  "type": "object",
  "required": [
    "product_id",
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "enum": [
        "add",
        "remove",
        "replace"
      ],
      "type": "string",
      "description": "Patch operation"
    },
    "path": {
      "type": "string",
      "description": "JSON Pointer path"
    },
    "value": {
      "type": "string",
      "description": "New value as JSON string"
    },
    "product_id": {
      "type": "string",
      "description": "Product ID"
    }
  }
}

paypal_create_plan

Create a billing plan for recurring payments.

Args:

product_id: ID of the product this plan belongs to (required)
name: Plan name (required)
description: Plan description (optional)
status: Plan status - 'ACTIVE' or 'INACTIVE' (default: ACTIVE)
billing_cycles: JSON array of billing cycles with format: [{"frequency": {"interval_unit": "MONTH", "interval_count": 1}, "tenure_type": "REGULAR", "sequence": 1, "total_cycles": 0, "pricing_scheme": {"fixed_price": {"value": "10.00", "currency_code": "USD"}}}]
payment_preferences: JSON object with setup_fee, auto_bill_outstanding, etc. (optional)

Returns: The created plan with ID.

{
  "type": "object",
  "required": [
    "product_id",
    "name",
    "billing_cycles"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Plan name"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string",
      "default": "ACTIVE",
      "description": "Plan status"
    },
    "product_id": {
      "type": "string",
      "description": "Product ID"
    },
    "description": {
      "type": "string",
      "description": "Plan description"
    },
    "billing_cycles": {
      "type": "string",
      "description": "JSON array of billing cycles"
    },
    "payment_preferences": {
      "type": "string",
      "description": "JSON payment preferences"
    }
  }
}

paypal_update_plan

Update a billing plan with patch operations.

Args:

plan_id: The plan ID to update
op: Patch operation type
path: JSON Pointer path to update (e.g., '/description')
value: New value as JSON string

Returns: Confirmation of update.

{
  "type": "object",
  "required": [
    "plan_id",
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "enum": [
        "add",
        "remove",
        "replace"
      ],
      "type": "string",
      "description": "Patch operation"
    },
    "path": {
      "type": "string",
      "description": "JSON Pointer path"
    },
    "value": {
      "type": "string",
      "description": "New value as JSON string"
    },
    "plan_id": {
      "type": "string",
      "description": "Plan ID"
    }
  }
}

paypal_activate_plan

Activate a billing plan.

Args:

plan_id: The plan ID to activate

Returns: Confirmation of activation.

{
  "type": "object",
  "required": [
    "plan_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "description": "Plan ID to activate"
    }
  }
}

paypal_deactivate_plan

Deactivate a billing plan.

Args:

plan_id: The plan ID to deactivate

Returns: Confirmation of deactivation.

{
  "type": "object",
  "required": [
    "plan_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "description": "Plan ID to deactivate"
    }
  }
}

paypal_update_plan_pricing

Update pricing for a billing plan.

Args:

plan_id: The plan ID
pricing_schemes: JSON array of pricing scheme updates

Returns: Confirmation of pricing update.

{
  "type": "object",
  "required": [
    "plan_id",
    "pricing_schemes"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "description": "Plan ID"
    },
    "pricing_schemes": {
      "type": "string",
      "description": "JSON array of pricing scheme updates"
    }
  }
}

paypal_create_subscription

Create a subscription for a billing plan.

Args:

plan_id: The plan ID to subscribe to (required)
subscriber_email: Subscriber's email address (optional)
subscriber_given_name: Subscriber's first name (optional)
subscriber_surname: Subscriber's last name (optional)
start_time: Subscription start time in ISO 8601 format (optional)
custom_id: Custom merchant ID for tracking (optional)
return_url: URL to redirect after approval (optional)
cancel_url: URL to redirect if cancelled (optional)

Returns: The created subscription with approval links.

{
  "type": "object",
  "required": [
    "plan_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "description": "Plan ID"
    },
    "custom_id": {
      "type": "string",
      "description": "Custom merchant ID"
    },
    "cancel_url": {
      "type": "string",
      "description": "Cancel URL"
    },
    "return_url": {
      "type": "string",
      "description": "Return URL"
    },
    "start_time": {
      "type": "string",
      "description": "Start time (ISO 8601)"
    },
    "subscriber_email": {
      "type": "string",
      "description": "Subscriber email"
    },
    "subscriber_surname": {
      "type": "string",
      "description": "Subscriber last name"
    },
    "subscriber_given_name": {
      "type": "string",
      "description": "Subscriber first name"
    }
  }
}

paypal_get_subscription

Get details of a subscription.

Args:

subscription_id: The subscription ID
format: Response format ('json' or 'markdown')

Returns: Subscription details including status, billing info, and subscriber.

{
  "type": "object",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_update_subscription

Update a subscription with patch operations.

Args:

subscription_id: The subscription ID to update
op: Patch operation type
path: JSON Pointer path to update
value: New value as JSON string

Returns: Confirmation of update.

{
  "type": "object",
  "required": [
    "subscription_id",
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "enum": [
        "add",
        "remove",
        "replace"
      ],
      "type": "string",
      "description": "Patch operation"
    },
    "path": {
      "type": "string",
      "description": "JSON Pointer path"
    },
    "value": {
      "type": "string",
      "description": "New value as JSON string"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_revise_subscription

Revise a subscription (change plan, quantity, etc.).

Args:

subscription_id: The subscription ID to revise
plan_id: New plan ID (optional)
quantity: New quantity (optional)
effective_time: When revision takes effect (optional)

Returns: The revised subscription details.

{
  "type": "object",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "description": "New plan ID"
    },
    "quantity": {
      "type": "string",
      "description": "New quantity"
    },
    "effective_time": {
      "type": "string",
      "description": "Effective time (ISO 8601)"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_suspend_subscription

Suspend an active subscription.

Args:

subscription_id: The subscription ID to suspend
reason: Reason for suspension (required)

Returns: Confirmation of suspension.

{
  "type": "object",
  "required": [
    "subscription_id",
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Reason for suspension"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_activate_subscription

Activate a suspended subscription.

Args:

subscription_id: The subscription ID to activate
reason: Reason for activation (required)

Returns: Confirmation of activation.

{
  "type": "object",
  "required": [
    "subscription_id",
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Reason for activation"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_cancel_subscription

Cancel a subscription.

Args:

subscription_id: The subscription ID to cancel
reason: Reason for cancellation (required)

Returns: Confirmation of cancellation.

{
  "type": "object",
  "required": [
    "subscription_id",
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Reason for cancellation"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_capture_subscription_payment

Capture an outstanding payment for a subscription.

Args:

subscription_id: The subscription ID
note: Note about the capture (required)
capture_type: Type of capture - 'OUTSTANDING_BALANCE' (required)
currency_code: Currency code (required)
value: Amount to capture (required)

Returns: The capture transaction details.

{
  "type": "object",
  "required": [
    "subscription_id",
    "note",
    "capture_type",
    "currency_code",
    "value"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "Capture note"
    },
    "value": {
      "type": "string",
      "description": "Amount to capture"
    },
    "capture_type": {
      "enum": [
        "OUTSTANDING_BALANCE"
      ],
      "type": "string",
      "description": "Capture type"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_list_subscription_transactions

List transactions for a subscription.

Args:

subscription_id: The subscription ID
start_time: Start of date range (ISO 8601) (required)
end_time: End of date range (ISO 8601) (required)
format: Response format ('json' or 'markdown')

Returns: List of subscription transactions.

{
  "type": "object",
  "required": [
    "subscription_id",
    "start_time",
    "end_time"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "end_time": {
      "type": "string",
      "description": "End time (ISO 8601)"
    },
    "start_time": {
      "type": "string",
      "description": "Start time (ISO 8601)"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

paypal_add_tracking

Add tracking information for a captured payment.

Args:

transaction_id: The PayPal transaction/capture ID (required)
tracking_number: Carrier tracking number (required)
carrier: Carrier name (required, e.g., 'UPS', 'FEDEX', 'USPS', 'DHL')
carrier_name_other: Custom carrier name if carrier is 'OTHER' (optional)
status: Tracking status - 'SHIPPED', 'ON_HOLD', 'DELIVERED', 'CANCELLED' (required)
notify_buyer: Send tracking notification to buyer (default: true)
shipment_date: Date of shipment (optional)

Returns: The tracking information.

{
  "type": "object",
  "required": [
    "transaction_id",
    "tracking_number",
    "carrier",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "SHIPPED",
        "ON_HOLD",
        "DELIVERED",
        "CANCELLED"
      ],
      "type": "string",
      "description": "Tracking status"
    },
    "carrier": {
      "type": "string",
      "description": "Carrier code (UPS, FEDEX, USPS, DHL, etc.)"
    },
    "notify_buyer": {
      "type": "boolean",
      "default": true,
      "description": "Notify buyer"
    },
    "shipment_date": {
      "type": "string",
      "description": "Shipment date"
    },
    "transaction_id": {
      "type": "string",
      "description": "Transaction/capture ID"
    },
    "tracking_number": {
      "type": "string",
      "description": "Tracking number"
    },
    "carrier_name_other": {
      "type": "string",
      "description": "Custom carrier name"
    }
  }
}

paypal_add_tracking_batch

Add tracking information for multiple shipments in a batch.

Args:

trackers: JSON array of tracking objects with format: [{"transaction_id": "...", "tracking_number": "...", "carrier": "UPS", "status": "SHIPPED"}]

Returns: Batch result with success/failure for each tracker.

{
  "type": "object",
  "required": [
    "trackers"
  ],
  "properties": {
    "trackers": {
      "type": "string",
      "description": "JSON array of tracker objects"
    }
  }
}

paypal_get_tracking

Get tracking information for a transaction.

Args:

transaction_id: The PayPal transaction/capture ID
tracking_number: The tracking number
format: Response format ('json' or 'markdown')

Returns: Tracking details including status and carrier.

{
  "type": "object",
  "required": [
    "transaction_id",
    "tracking_number"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "transaction_id": {
      "type": "string",
      "description": "Transaction ID"
    },
    "tracking_number": {
      "type": "string",
      "description": "Tracking number"
    }
  }
}

paypal_update_tracking

Update tracking information for a shipment.

Args:

transaction_id: The PayPal transaction/capture ID (required)
tracking_number: The tracking number (required)
carrier: New carrier code (optional)
carrier_name_other: Custom carrier name (optional)
status: New tracking status (optional)
notify_buyer: Send update notification (optional)

Returns: Confirmation of update.

{
  "type": "object",
  "required": [
    "transaction_id",
    "tracking_number"
  ],
  "properties": {
    "status": {
      "enum": [
        "SHIPPED",
        "ON_HOLD",
        "DELIVERED",
        "CANCELLED"
      ],
      "type": "string",
      "description": "Status"
    },
    "carrier": {
      "type": "string",
      "description": "Carrier code"
    },
    "notify_buyer": {
      "type": "boolean",
      "description": "Notify buyer"
    },
    "transaction_id": {
      "type": "string",
      "description": "Transaction ID"
    },
    "tracking_number": {
      "type": "string",
      "description": "Tracking number"
    },
    "carrier_name_other": {
      "type": "string",
      "description": "Custom carrier name"
    }
  }
}

paypal_list_transactions

Search transactions within a date range.

Args:

start_date: Start of date range (ISO 8601) (required)
end_date: End of date range (ISO 8601) (required)
transaction_id: Filter by transaction ID (optional)
transaction_type: Filter by transaction type (optional)
transaction_status: Filter by status (optional)
transaction_amount: Filter by amount (optional)
transaction_currency: Filter by currency (optional)
payment_instrument_type: Filter by payment type (optional)
store_id: Filter by store ID (optional)
terminal_id: Filter by terminal ID (optional)
page: Page number (optional)
page_size: Items per page (optional)
format: Response format ('json' or 'markdown')

Returns: List of transactions matching criteria.

{
  "type": "object",
  "required": [
    "start_date",
    "end_date"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "end_date": {
      "type": "string",
      "description": "End date (ISO 8601)"
    },
    "store_id": {
      "type": "string",
      "description": "Store ID filter"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    },
    "start_date": {
      "type": "string",
      "description": "Start date (ISO 8601)"
    },
    "terminal_id": {
      "type": "string",
      "description": "Terminal ID filter"
    },
    "transaction_id": {
      "type": "string",
      "description": "Transaction ID filter"
    },
    "transaction_type": {
      "type": "string",
      "description": "Transaction type filter"
    },
    "transaction_amount": {
      "type": "string",
      "description": "Amount filter"
    },
    "transaction_currency": {
      "type": "string",
      "description": "Currency filter"
    }
  }
}

paypal_get_balances

Get account balances.

Args:

as_of_time: Get balances as of this time (ISO 8601) (optional)
currency_code: Filter by currency (optional)
format: Response format ('json' or 'markdown')

Returns: Account balances by currency.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "as_of_time": {
      "type": "string",
      "description": "As-of time (ISO 8601)"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency filter"
    }
  }
}

paypal_create_webhook

Create a webhook to receive event notifications.

Args:

url: Webhook endpoint URL (required, must be HTTPS)
event_types: JSON array of event type names to subscribe to, e.g., ["PAYMENT.CAPTURE.COMPLETED", "PAYMENT.CAPTURE.DENIED"]

Returns: The created webhook with ID.

{
  "type": "object",
  "required": [
    "url",
    "event_types"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Webhook URL (HTTPS required)"
    },
    "event_types": {
      "type": "string",
      "description": "JSON array of event type names"
    }
  }
}

paypal_list_webhooks

List all webhooks for this application.

Args:

format: Response format ('json' or 'markdown')

Returns: List of webhooks with their URLs and event subscriptions.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

paypal_get_webhook

Get details of a webhook.

Args:

webhook_id: The webhook ID
format: Response format ('json' or 'markdown')

Returns: Webhook details including URL and subscribed events.

{
  "type": "object",
  "required": [
    "webhook_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "webhook_id": {
      "type": "string",
      "description": "Webhook ID"
    }
  }
}

paypal_update_webhook

Update a webhook with patch operations.

Args:

webhook_id: The webhook ID to update
op: Patch operation type
path: JSON Pointer path to update (e.g., '/url' or '/event_types')
value: New value as JSON string

Returns: The updated webhook.

{
  "type": "object",
  "required": [
    "webhook_id",
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "enum": [
        "add",
        "remove",
        "replace"
      ],
      "type": "string",
      "description": "Patch operation"
    },
    "path": {
      "type": "string",
      "description": "JSON Pointer path"
    },
    "value": {
      "type": "string",
      "description": "New value as JSON string"
    },
    "webhook_id": {
      "type": "string",
      "description": "Webhook ID"
    }
  }
}

paypal_delete_webhook

Delete a webhook.

Args:

webhook_id: The webhook ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "webhook_id"
  ],
  "properties": {
    "webhook_id": {
      "type": "string",
      "description": "Webhook ID to delete"
    }
  }
}

paypal_list_webhook_event_types

List all available webhook event types.

Args:

format: Response format ('json' or 'markdown')

Returns: List of event types that can be subscribed to.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

paypal_list_webhook_events

List webhook event notifications.

Args:

page_size: Number of events per page (optional)
start_time: Filter events after this time (ISO 8601) (optional)
end_time: Filter events before this time (ISO 8601) (optional)
transaction_id: Filter by transaction ID (optional)
event_type: Filter by event type (optional)
format: Response format ('json' or 'markdown')

Returns: List of webhook events.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "end_time": {
      "type": "string",
      "description": "End time (ISO 8601)"
    },
    "page_size": {
      "type": "integer",
      "description": "Items per page"
    },
    "event_type": {
      "type": "string",
      "description": "Event type filter"
    },
    "start_time": {
      "type": "string",
      "description": "Start time (ISO 8601)"
    },
    "transaction_id": {
      "type": "string",
      "description": "Transaction ID filter"
    }
  }
}

paypal_get_webhook_event

Get details of a webhook event.

Args:

event_id: The event ID
format: Response format ('json' or 'markdown')

Returns: Event details including type, resource, and summary.

{
  "type": "object",
  "required": [
    "event_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "event_id": {
      "type": "string",
      "description": "Event ID"
    }
  }
}

paypal_resend_webhook_event

Resend a webhook event notification.

Args:

event_id: The event ID to resend
webhook_ids: JSON array of webhook IDs to send to (optional, sends to all if not specified)

Returns: Confirmation of resend.

{
  "type": "object",
  "required": [
    "event_id"
  ],
  "properties": {
    "event_id": {
      "type": "string",
      "description": "Event ID to resend"
    },
    "webhook_ids": {
      "type": "string",
      "description": "JSON array of webhook IDs"
    }
  }
}

paypal_verify_webhook_signature

Verify the signature of a webhook event.

Args:

auth_algo: The auth algorithm from header
cert_url: The certificate URL from header
transmission_id: The transmission ID from header
transmission_sig: The transmission signature from header
transmission_time: The transmission time from header
webhook_id: Your webhook ID
webhook_event: The full webhook event JSON

Returns: Verification status.

{
  "type": "object",
  "required": [
    "auth_algo",
    "cert_url",
    "transmission_id",
    "transmission_sig",
    "transmission_time",
    "webhook_id",
    "webhook_event"
  ],
  "properties": {
    "cert_url": {
      "type": "string",
      "description": "Certificate URL"
    },
    "auth_algo": {
      "type": "string",
      "description": "Auth algorithm"
    },
    "webhook_id": {
      "type": "string",
      "description": "Your webhook ID"
    },
    "webhook_event": {
      "type": "string",
      "description": "Full webhook event JSON"
    },
    "transmission_id": {
      "type": "string",
      "description": "Transmission ID"
    },
    "transmission_sig": {
      "type": "string",
      "description": "Transmission signature"
    },
    "transmission_time": {
      "type": "string",
      "description": "Transmission time"
    }
  }
}

paypal_simulate_webhook_event

Simulate a webhook event for testing.

Args:

webhook_id: The webhook ID to simulate for (optional)
url: URL to send simulated event to (optional if webhook_id provided)
event_type: Event type to simulate (required)
resource_version: API resource version (optional, default: '1.0')

Returns: The simulated event details.

{
  "type": "object",
  "required": [
    "event_type"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Target URL"
    },
    "event_type": {
      "type": "string",
      "description": "Event type to simulate"
    },
    "webhook_id": {
      "type": "string",
      "description": "Webhook ID"
    },
    "resource_version": {
      "type": "string",
      "default": "1.0",
      "description": "Resource version"
    }
  }
}