Skip to main content
PayPal
PayPal
61 actions · 1 auth method
PreviewPayments

Authentication

OAuth 2.0 (Client Credentials)

PayPal uses OAuth 2.0 Client Credentials for server-to-server API access. You need a PayPal Developer account with a RES…Guides: Connector Profile, Link Account
Actions
61 actions
Action
Description
Create Order
Create a new PayPal order for payment processing
Get Order
Show details for an order by ID
Capture Order Payment
Capture payment for an approved order
Authorize Order Payment
Authorize payment for an approved order
Update Order
Update an order with CREATED or APPROVED status
Get Captured Payment
Retrieve details of a captured payment
Refund Captured Payment
Refund a captured payment in full or partially
Get Refund
Retrieve details of a specific refund
Get Authorization
Retrieve details of an authorized payment
Capture Authorized Payment
Capture an authorized payment
Void Authorization
Void an authorized payment
List Invoices
List invoices with optional filtering and pagination
Get Invoice
Retrieve details of a specific invoice by ID
Create Draft Invoice
Create a new draft invoice
Update Invoice
Fully update an existing invoice — use this to change payment terms, line items, recipient, amounts, or any other invoic…
Delete Invoice
Delete a draft invoice by ID
Send Invoice
Send or schedule a draft invoice to the recipient
Cancel Sent Invoice
Cancel a sent invoice
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
Generate the next sequential invoice number
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
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
Records a refund against a paid invoice via POST /v2/invoicing/invoices/{invoice_id}/refunds. If the total refunded amou…
Delete External Payment
Delete an external payment from an invoice
List Products
List catalog products with pagination
Get Product
Retrieve details of a specific catalog product
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
Update a catalog product’s description, category, image_url, or home_url fields using JSON Patch with “add” or “remove”…
List Subscription Plans
List subscription billing plans with pagination
Get Subscription Plan
Retrieve details of a specific subscription plan
Create Subscription Plan
Create a new subscription billing plan linked to a product, defining pricing, billing cycles, and payment preferences. F…
Update Plan
Update a billing plan’s name, description, payment preferences, or tax settings using JSON Patch. Returns 204 No Content…
Activate Plan
Activate a billing plan that was created with status CREATED. Returns 204 No Content on success.
Deactivate Plan
Deactivate an ACTIVE billing plan. No new subscriptions can be created against it. Returns 204 No Content on success.
Get Subscription
Retrieve the full details of a specific PayPal subscription including its status, billing info, subscriber details, and…
Create Subscription
Create a new PayPal subscription that enrolls a subscriber into a billing plan, returning HATEOAS approval links the sub…
Update Subscription
Update an ACTIVE or SUSPENDED subscription using JSON Patch operations. Returns 204 No Content on success.
Revise Subscription Plan Or Quantity
Revise the plan, quantity, or shipping details of a subscription. Requires buyer re-approval via redirect.
Cancel Subscription
Cancel an active subscription
Suspend Subscription
Suspend an active subscription
Activate Subscription
Activate a suspended subscription
List Subscription Transactions
List transactions for a specific subscription
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
Retrieve details of a batch payout
Get Payout Item
Retrieve details of a specific payout item
Cancel Unclaimed Payout Item
ONLY works on UNCLAIMED payout items — PENDING items cannot be cancelled (returns 400). Always check transaction_status…
List Disputes
List disputes with optional filtering by state, date range, or transaction ID. Supports page and page_size (1-50, defaul…
Get Dispute
Retrieve details of a specific dispute
Accept Dispute Claim
Accept a dispute claim and refund the buyer
Send Dispute Message
Send a message about a dispute to the other party
Escalate Dispute To Claim
Escalate a dispute to a PayPal claim
List Transactions
Search for transactions within a date range
List Balances
List account balances by currency
List Webhooks
List all webhooks for the app
Get Webhook
Retrieve full details of a specific webhook by its ID
Create Webhook
Create a new webhook to receive event notifications. WARNING — PayPal sends a live HTTPS request to the URL at creation…
Delete Webhook
Delete a webhook by ID
Update Webhook
Update a webhook’s URL or event types using JSON Patch. Only the “replace” operation is supported.
List Webhook Event Types
List all available webhook event types
List Webhook Event Notifications
List webhook event notifications with optional filtering by date range, transaction ID, or event type. If filtering by d…
Get Webhook Event
Retrieve details of a specific webhook event notification by ID

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/paypal/filled/png

Connector Profile

PayPal - OAuth 2.0 (Client Credentials)
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/paypal/filled/png

Link Account

PayPal - OAuth 2.0 (Client Credentials)
4

Use Actions

Invoke actions using one of the methods below: