> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PayPal

> How to set up the PayPal connector, plus the actions and events that are available.

![PayPal](https://stackone-logos.com/api/paypal/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/paypal/changelog.md)

[64 actions](#actions) · [51 events](#events) · 1 auth method

Payments
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/paypal/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> PayPal uses OAuth 2.0 Client Credentials for server-to-server API access. You need a PayPal Developer account with a RES...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/paypal/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

64 actions

ActionDescription

Create Order`paypal_create_order`

Create a new PayPal order for payment processing

Get Order`paypal_get_order`

Show details for an order by ID

Capture Order Payment`paypal_capture_order`

Capture payment for an approved order

Authorize Order Payment`paypal_authorize_order`

Authorize payment for an approved order

Update Order`paypal_update_order`

Update an order with CREATED or APPROVED status

Get Captured Payment`paypal_get_captured_payment`

Retrieve details of a captured payment

Refund Captured Payment`paypal_refund_captured_payment`

Refund a captured payment in full or partially

Get Refund`paypal_get_refund`

Retrieve details of a specific refund

Get Authorization`paypal_get_authorization`

Retrieve details of an authorized payment

Capture Authorized Payment`paypal_capture_authorization`

Capture an authorized payment

Void Authorization`paypal_void_authorization`

Void an authorized payment

List Invoices`paypal_list_invoices`

List invoices with optional filtering and pagination

Get Invoice`paypal_get_invoice`

Retrieve details of a specific invoice by ID

Create Draft Invoice`paypal_create_draft_invoice`

Create a new draft invoice

Update Invoice`paypal_update_invoice`

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

Delete Invoice`paypal_delete_invoice`

Delete a draft invoice by ID

Send Invoice`paypal_send_invoice`

Send or schedule a draft invoice to the recipient

Cancel Sent Invoice`paypal_cancel_invoice`

Cancel a sent invoice

Record Invoice Payment`paypal_record_invoice_payment`

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

Generate Invoice Number`paypal_generate_invoice_number`

Generate the next sequential invoice number

Search Invoices`paypal_search_invoices`

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

Send Invoice Reminder`paypal_send_invoice_reminder`

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

Record Invoice Refund`paypal_record_invoice_refund`

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

Delete External Payment`paypal_delete_external_payment`

Delete an external payment from an invoice

List Products`paypal_list_products`

List catalog products with pagination

Get Product`paypal_get_product`

Retrieve details of a specific catalog product

Create Product`paypal_create_product`

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

Update Product`paypal_update_product`

Update a catalog product's description, category, image\_url, or home\_url fields using JSON Patch with "add" or "remove"...

List Subscription Plans`paypal_list_plans`

List subscription billing plans with pagination

Get Subscription Plan`paypal_get_plan`

Retrieve details of a specific subscription plan

Create Subscription Plan`paypal_create_plan`

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

Update Plan`paypal_update_plan`

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

Activate Plan`paypal_activate_plan`

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

Deactivate Plan`paypal_deactivate_plan`

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

Get Subscription`paypal_get_subscription`

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

Create Subscription`paypal_create_subscription`

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

Update Subscription`paypal_update_subscription`

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

Revise Subscription Plan Or Quantity`paypal_revise_subscription`

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

Cancel Subscription`paypal_cancel_subscription`

Cancel an active subscription

Suspend Subscription`paypal_suspend_subscription`

Suspend an active subscription

Activate Subscription`paypal_activate_subscription`

Activate a suspended subscription

List Subscription Transactions`paypal_list_subscription_transactions`

List transactions for a specific subscription

Create Batch Payout`paypal_create_batch_payout`

Create a batch payout to send payments to multiple recipients (max 15,000 items). sender\_batch\_id must be unique per 30...

Get Batch Payout`paypal_get_batch_payout`

Retrieve details of a batch payout

Get Payout Item`paypal_get_payout_item`

Retrieve details of a specific payout item

Cancel Unclaimed Payout Item`paypal_cancel_payout_item`

ONLY works on UNCLAIMED payout items — PENDING items cannot be cancelled (returns 400). Always check transaction\_status...

List Disputes`paypal_list_disputes`

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

Get Dispute`paypal_get_dispute`

Retrieve details of a specific dispute

Accept Dispute Claim`paypal_accept_dispute_claim`

Accept a dispute claim and refund the buyer

Send Dispute Message`paypal_send_dispute_message`

Send a message about a dispute to the other party

Escalate Dispute To Claim`paypal_escalate_dispute`

Escalate a dispute to a PayPal claim

List Transactions`paypal_list_transactions`

Search for transactions within a date range

List Balances`paypal_list_balances`

List account balances by currency

List Webhooks`paypal_list_webhooks`

List all webhooks for the app

Get Webhook`paypal_get_webhook`

Retrieve full details of a specific webhook by its ID

Create Webhook`paypal_create_webhook`

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

Delete Webhook`paypal_delete_webhook`

Delete a webhook by ID

Update Webhook`paypal_update_webhook`

Update a webhook's URL or event types using JSON Patch. Only the "replace" operation is supported.

List Webhook Event Types`paypal_list_webhook_event_types`

List all available webhook event types

List Webhook Event Notifications`paypal_list_webhook_events`

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

Get Webhook Event`paypal_get_webhook_event`

Retrieve details of a specific webhook event notification by ID

Get Unified Credentials`paypal_unified_get_me`

Get the current PayPal connection's unified credentials and identity.

List Unified Users`paypal_unified_list_users`

List unified users (staff logins) on the connected PayPal business account.

Get Unified User`paypal_unified_get_user`

Get a unified PayPal user by ID.

## Events

Tags

Select all
|
Clear

Authorizations

Captures

Disputes

Invoices

Orders

Payouts

Plans

Refunds

Sales

Subscriptions

Webhooks

No tags found

51 events

EventDescriptionTags

Order Approved`paypal_webhook_order_approved`

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

OrdersWebhooks

Order Completed`paypal_webhook_order_completed`

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

OrdersWebhooks

Payment Approval Reversed`paypal_webhook_payment_approval_reversed`

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

OrdersWebhooks

Payment Capture Completed`paypal_webhook_capture_completed`

Fired when a payment capture completes successfully.

CapturesWebhooks

Payment Capture Denied`paypal_webhook_capture_denied`

Fired when a payment capture is denied.

CapturesWebhooks

Payment Capture Pending`paypal_webhook_capture_pending`

Fired when a payment capture is pending review or clearing.

CapturesWebhooks

Payment Capture Refunded`paypal_webhook_capture_refunded`

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

RefundsWebhooks

Payment Capture Reversed`paypal_webhook_capture_reversed`

Fired when a captured payment is reversed by PayPal.

RefundsWebhooks

Payment Authorization Created`paypal_webhook_authorization_created`

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

AuthorizationsWebhooks

Payment Authorization Voided`paypal_webhook_authorization_voided`

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

AuthorizationsWebhooks

Sale Completed`paypal_webhook_sale_completed`

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

SalesWebhooks

Sale Denied`paypal_webhook_sale_denied`

Fired when a sale (v1 payment) is denied.

SalesWebhooks

Sale Pending`paypal_webhook_sale_pending`

Fired when a sale (v1 payment) is pending.

SalesWebhooks

Sale Refunded`paypal_webhook_sale_refunded`

Fired when a sale (v1 payment) is refunded.

RefundsWebhooks

Sale Reversed`paypal_webhook_sale_reversed`

Fired when a sale (v1 payment) is reversed.

RefundsWebhooks

Payout Batch Success`paypal_webhook_payouts_batch_success`

Fired when a batch payout completes successfully.

PayoutsWebhooks

Payout Batch Denied`paypal_webhook_payouts_batch_denied`

Fired when a batch payout is denied.

PayoutsWebhooks

Payout Batch Processing`paypal_webhook_payouts_batch_processing`

Fired when a batch payout begins processing.

PayoutsWebhooks

Payout Item Succeeded`paypal_webhook_payouts_item_succeeded`

Fired when an individual payout item succeeds.

PayoutsWebhooks

Payout Item Failed`paypal_webhook_payouts_item_failed`

Fired when an individual payout item fails.

PayoutsWebhooks

Payout Item Blocked`paypal_webhook_payouts_item_blocked`

Fired when an individual payout item is blocked.

PayoutsWebhooks

Payout Item Canceled`paypal_webhook_payouts_item_canceled`

Fired when an individual payout item is canceled.

PayoutsWebhooks

Payout Item Held`paypal_webhook_payouts_item_held`

Fired when an individual payout item is held.

PayoutsWebhooks

Payout Item Refunded`paypal_webhook_payouts_item_refunded`

Fired when an individual payout item is refunded.

PayoutsWebhooks

Payout Item Returned`paypal_webhook_payouts_item_returned`

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

PayoutsWebhooks

Payout Item Unclaimed`paypal_webhook_payouts_item_unclaimed`

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

PayoutsWebhooks

Invoice Created`paypal_webhook_invoice_created`

Fired when an invoice is created.

InvoicesWebhooks

Invoice Updated`paypal_webhook_invoice_updated`

Fired when an invoice is updated.

InvoicesWebhooks

Invoice Cancelled`paypal_webhook_invoice_cancelled`

Fired when an invoice is cancelled.

InvoicesWebhooks

Invoice Paid`paypal_webhook_invoice_paid`

Fired when an invoice is fully paid.

InvoicesWebhooks

Invoice Refunded`paypal_webhook_invoice_refunded`

Fired when an invoice is refunded.

InvoicesWebhooks

Invoice Scheduled`paypal_webhook_invoice_scheduled`

Fired when an invoice is scheduled for future sending.

InvoicesWebhooks

Billing Plan Created`paypal_webhook_plan_created`

Fired when a billing plan is created.

PlansWebhooks

Billing Plan Updated`paypal_webhook_plan_updated`

Fired when a billing plan is updated.

PlansWebhooks

Billing Plan Activated`paypal_webhook_plan_activated`

Fired when a billing plan is activated.

PlansWebhooks

Billing Plan Deactivated`paypal_webhook_plan_deactivated`

Fired when a billing plan is deactivated.

PlansWebhooks

Billing Plan Pricing Change Activated`paypal_webhook_plan_pricing_change_activated`

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

PlansWebhooks

Subscription Created`paypal_webhook_subscription_created`

Fired when a subscription is created (APPROVAL\_PENDING).

SubscriptionsWebhooks

Subscription Activated`paypal_webhook_subscription_activated`

Fired when a subscription becomes active.

SubscriptionsWebhooks

Subscription Updated`paypal_webhook_subscription_updated`

Fired when a subscription is updated.

SubscriptionsWebhooks

Subscription Cancelled`paypal_webhook_subscription_cancelled`

Fired when a subscription is cancelled.

SubscriptionsWebhooks

Subscription Suspended`paypal_webhook_subscription_suspended`

Fired when a subscription is suspended.

SubscriptionsWebhooks

Subscription Expired`paypal_webhook_subscription_expired`

Fired when a subscription expires.

SubscriptionsWebhooks

Subscription Re-Activated`paypal_webhook_subscription_reactivated`

Fired when a suspended subscription is re-activated.

SubscriptionsWebhooks

Subscription Payment Failed`paypal_webhook_subscription_payment_failed`

Fired when a recurring subscription payment fails.

SubscriptionsWebhooks

Customer Dispute Created`paypal_webhook_dispute_created`

Fired when a customer opens a dispute.

DisputesWebhooks

Customer Dispute Updated`paypal_webhook_dispute_updated`

Fired when a customer dispute is updated.

DisputesWebhooks

Customer Dispute Resolved`paypal_webhook_dispute_resolved`

Fired when a customer dispute is resolved.

DisputesWebhooks

Risk Dispute Created`paypal_webhook_risk_dispute_created`

Fired when a risk-based dispute is created.

DisputesWebhooks

Generic PayPal Webhook`paypal_webhook_generic`

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

Webhooks

Webhook Active Check`paypal_webhook_active_check`

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

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.