PayPal
PayPal connector for managing orders, payments, subscriptions, invoices, payouts, and disputes via the PayPal REST API.
Categories: Payments, Fintech, E-Commerce, Invoicing
What you can ask
- List transactions in the last 7 days over $1,000, sorted by amount.
- Issue a refund for transaction
TXN-12345for the full amount. - Pull total volume by currency for last month.
Set up
PayPal connects with credentials from your PayPal account. Have these values ready:
- Client ID
- Client secret
- Environment
- Go to Organization > Connectors and find PayPal.
- Click Enable and choose which tools to allow.
- Each member enters their own values the first time they use it.
To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.
Tools
PayPal offers 62 tools. Admins choose which ones agents can use. See Tool permission groups.
Read (22)
View and search information without changing it.
| Tool | What it does |
|---|---|
generate_invoice_number | Generate the next invoice number in PayPal's sequence. |
get_authorized_payment | Get details of an authorized PayPal payment by authorization ID. |
get_captured_payment | Get details of a captured PayPal payment by capture ID. |
get_dispute | Get full details of a PayPal dispute by ID including transactions, messages, and evidence. |
get_invoice | Get details of a PayPal invoice by ID including items, amounts, and payment status. |
get_order | Get details of a PayPal order by ID including status, purchase units, and payment info. |
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. |
get_plan | Get details of a PayPal billing plan by ID including billing cycles and pricing. |
get_product | Get details of a PayPal catalog product by ID. |
get_refund | Get details of a PayPal refund by refund ID. |
get_subscription | Get details of a PayPal subscription by ID including billing info and status. |
get_webhook | Get details of a PayPal webhook by ID including URL and subscribed event types. |
list_disputes | List PayPal disputes with optional filters for state and start time. |
list_invoices | List PayPal invoices with pagination. |
list_plans | List billing plans in PayPal with optional product_id filter. |
list_products | List catalog products in PayPal with pagination. |
list_subscription_transactions | List transactions for a PayPal subscription within a date range. |
list_webhook_event_types | List all available PayPal webhook event types you can subscribe to. |
list_webhooks | List all PayPal webhooks for your application. |
validate_credential | Validate PayPal API credentials (client_id/client_secret). |
verify_webhook_signature | Verify a PayPal webhook signature to ensure the event is authentic. |
Write (12)
Create or send data.
| Tool | What it does |
|---|---|
create_invoice | Create a draft PayPal invoice. |
create_order | Create a PayPal order with CAPTURE or AUTHORIZE intent. |
create_payout | Create a PayPal payout batch to send money to multiple recipients via email, phone, or PayPal ID. |
create_plan | Create a billing plan for subscriptions. |
create_product | Create a catalog product in PayPal. |
create_subscription | Create a PayPal subscription for recurring payments. |
create_webhook | Create a PayPal webhook to receive event notifications at your URL. |
provide_dispute_evidence | Provide evidence for a PayPal dispute such as tracking info or proof of delivery. |
reauthorize_payment | Reauthorize a PayPal payment to extend the authorization period. |
record_invoice_payment | Record an external payment on a PayPal invoice (e.g., cash, check, bank transfer). |
send_dispute_message | Send a message to the buyer or PayPal about a dispute. |
send_invoice | Send a PayPal draft invoice to recipients via email. |
Delete or overwrite (28)
Remove or replace existing data.
| Tool | What it does |
|---|---|
accept_dispute_claim | Accept a PayPal dispute claim and issue a refund to the buyer. |
acknowledge_return_item | Acknowledge receipt of a returned item in a PayPal dispute. |
activate_plan | Activate an inactive PayPal billing plan to make it available for subscriptions. |
activate_subscription | Activate a suspended PayPal subscription to resume billing. |
authorize_order | Authorize payment for an approved PayPal order. |
cancel_invoice | Cancel a sent PayPal invoice. |
cancel_payout_item | Cancel an unclaimed PayPal payout item. |
cancel_subscription | Cancel a PayPal subscription permanently. |
capture_authorized_payment | Capture funds from an authorized PayPal payment. |
capture_order | Capture payment for an approved PayPal order. |
capture_subscription_payment | Capture outstanding balance on a PayPal subscription. |
confirm_order | Confirm a PayPal order with a specific payment source before capture or authorization. |
deactivate_plan | Deactivate a PayPal billing plan. |
delete_invoice | Delete a PayPal draft invoice. |
delete_webhook | Delete a PayPal webhook. |
escalate_dispute | Escalate a PayPal dispute to a claim for PayPal to investigate and decide. |
make_dispute_offer | Make an offer to resolve a PayPal dispute with refund, return, or replacement. |
refund_captured_payment | Refund a captured PayPal payment. |
revise_subscription | Revise a PayPal subscription to change plan, quantity, or shipping. |
suspend_subscription | Suspend a PayPal subscription to temporarily stop billing. |
update_invoice | Fully update a PayPal draft invoice. |
update_order | Update a PayPal order's purchase_units using JSON Patch operations before capture. |
update_plan | Update a PayPal billing plan using JSON Patch operations. |
update_plan_pricing | Update pricing for a PayPal billing plan. |
update_product | Update a PayPal catalog product using JSON Patch operations. |
update_subscription | Update a PayPal subscription using JSON Patch operations. |
update_webhook | Update a PayPal webhook URL or event subscriptions using JSON Patch operations. |
void_authorized_payment | Void an authorized PayPal payment to release the hold on buyer's funds. |