PayPal

Create a new PayPal order for payment processing

Show details for an order by ID

Capture payment for an approved order

Authorize payment for an approved order

Update an order with CREATED or APPROVED status

Retrieve details of a captured payment

Refund a captured payment in full or partially

Retrieve details of a specific refund

Retrieve details of an authorized payment

Capture an authorized payment

Void an authorized payment

List invoices with optional filtering and pagination

Retrieve details of a specific invoice by ID

Create a new draft invoice

Fully update an existing invoice — use this to change payment terms, line items, recipient, amounts, or any other invoic…

Delete a draft invoice by ID

Send or schedule a draft invoice to the recipient

Cancel a sent invoice

Records an external payment (cash, check, bank transfer, etc.) against a sent invoice via POST /v2/invoicing/invoices/{i…

Generate the next sequential invoice number

Search for invoices using filters via POST /v2/invoicing/search-invoices. All filter fields go in the request body (not…

Send a reminder to the payer about an invoice. The invoice must have at least one recipient with an email address — invo…

Records a refund against a paid invoice via POST /v2/invoicing/invoices/{invoice_id}/refunds. If the total refunded amou…

Delete an external payment from an invoice

List catalog products with pagination

Retrieve details of a specific catalog product

Create a new catalog product. Only name and type are required; never block on a missing optional value like home_url or…

Update a catalog product’s description, category, image_url, or home_url fields using JSON Patch with “add” or “remove”…

List subscription billing plans with pagination

Retrieve details of a specific subscription plan

Create a new subscription billing plan linked to a product, defining pricing, billing cycles, and payment preferences. F…

Update a billing plan’s name, description, payment preferences, or tax settings using JSON Patch. Returns 204 No Content…

Activate a billing plan that was created with status CREATED. Returns 204 No Content on success.

Deactivate an ACTIVE billing plan. No new subscriptions can be created against it. Returns 204 No Content on success.

Retrieve the full details of a specific PayPal subscription including its status, billing info, subscriber details, and…

Create a new PayPal subscription that enrolls a subscriber into a billing plan, returning HATEOAS approval links the sub…

Update an ACTIVE or SUSPENDED subscription using JSON Patch operations. Returns 204 No Content on success.

Revise the plan, quantity, or shipping details of a subscription. Requires buyer re-approval via redirect.

Cancel an active subscription

Suspend an active subscription

Activate a suspended subscription

List transactions for a specific subscription

Create a batch payout to send payments to multiple recipients (max 15,000 items). sender_batch_id must be unique per 30…

Retrieve details of a batch payout

Retrieve details of a specific payout item

ONLY works on UNCLAIMED payout items — PENDING items cannot be cancelled (returns 400). Always check transaction_status…

List disputes with optional filtering by state, date range, or transaction ID. Supports page and page_size (1-50, defaul…

Retrieve details of a specific dispute

Accept a dispute claim and refund the buyer

Send a message about a dispute to the other party

Escalate a dispute to a PayPal claim

Search for transactions within a date range

List account balances by currency

List all webhooks for the app

Retrieve full details of a specific webhook by its ID

Create a new webhook to receive event notifications. WARNING — PayPal sends a live HTTPS request to the URL at creation…

Delete a webhook by ID

Update a webhook’s URL or event types using JSON Patch. Only the “replace” operation is supported.

List all available webhook event types

List webhook event notifications with optional filtering by date range, transaction ID, or event type. If filtering by d…

Retrieve details of a specific webhook event notification by ID

Fired when a payer approves a checkout order. The order is ready to be captured or authorized.

Fired when a checkout order is completed (all purchase units captured).

Fired when a buyer-approved checkout payment approval is reversed.

Fired when a payment capture completes successfully.

Fired when a payment capture is denied.

Fired when a payment capture is pending review or clearing.

Fired when a captured payment is refunded (fully or partially).

Fired when a captured payment is reversed by PayPal.

Fired when a payment authorization is created (funds held).

Fired when a payment authorization is voided and held funds are released.

Fired when a sale (v1 payment) completes. Commonly fired for subscription recurring payments.

Fired when a sale (v1 payment) is denied.

Fired when a sale (v1 payment) is pending.

Fired when a sale (v1 payment) is refunded.

Fired when a sale (v1 payment) is reversed.

Fired when a batch payout completes successfully.

Fired when a batch payout is denied.

Fired when a batch payout begins processing.

Fired when an individual payout item succeeds.

Fired when an individual payout item fails.

Fired when an individual payout item is blocked.

Fired when an individual payout item is canceled.

Fired when an individual payout item is held.

Fired when an individual payout item is refunded.

Fired when an individual payout item is returned (unclaimed funds returned to sender).

Fired when an individual payout item becomes unclaimed and is cancellable.

Fired when an invoice is created.

Fired when an invoice is updated.

Fired when an invoice is cancelled.

Fired when an invoice is fully paid.

Fired when an invoice is refunded.

Fired when an invoice is scheduled for future sending.

Fired when a billing plan is created.

Fired when a billing plan is updated.

Fired when a billing plan is activated.

Fired when a billing plan is deactivated.

Fired when a pricing change on a billing plan is activated.

Fired when a subscription is created (APPROVAL_PENDING).

Fired when a subscription becomes active.

Fired when a subscription is updated.

Fired when a subscription is cancelled.

Fired when a subscription is suspended.

Fired when a subscription expires.

Fired when a suspended subscription is re-activated.

Fired when a recurring subscription payment fails.

Fired when a customer opens a dispute.

Fired when a customer dispute is updated.

Fired when a customer dispute is resolved.

Fired when a risk-based dispute is created.

Processes any PayPal webhook event not matched by a specific handler, emitting the native event_type.

Answers PayPal connectivity/reachability checks with HTTP 200. Does not emit an event.