Skip to main content

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-12345 for 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
  1. Go to Organization > Connectors and find PayPal.
  2. Click Enable and choose which tools to allow.
  3. 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.

ToolWhat it does
generate_invoice_numberGenerate the next invoice number in PayPal's sequence.
get_authorized_paymentGet details of an authorized PayPal payment by authorization ID.
get_captured_paymentGet details of a captured PayPal payment by capture ID.
get_disputeGet full details of a PayPal dispute by ID including transactions, messages, and evidence.
get_invoiceGet details of a PayPal invoice by ID including items, amounts, and payment status.
get_orderGet details of a PayPal order by ID including status, purchase units, and payment info.
get_payout_batchGet details of a PayPal payout batch by ID including status and all payout items.
get_payout_itemGet details of a specific PayPal payout item by ID including transaction status.
get_planGet details of a PayPal billing plan by ID including billing cycles and pricing.
get_productGet details of a PayPal catalog product by ID.
get_refundGet details of a PayPal refund by refund ID.
get_subscriptionGet details of a PayPal subscription by ID including billing info and status.
get_webhookGet details of a PayPal webhook by ID including URL and subscribed event types.
list_disputesList PayPal disputes with optional filters for state and start time.
list_invoicesList PayPal invoices with pagination.
list_plansList billing plans in PayPal with optional product_id filter.
list_productsList catalog products in PayPal with pagination.
list_subscription_transactionsList transactions for a PayPal subscription within a date range.
list_webhook_event_typesList all available PayPal webhook event types you can subscribe to.
list_webhooksList all PayPal webhooks for your application.
validate_credentialValidate PayPal API credentials (client_id/client_secret).
verify_webhook_signatureVerify a PayPal webhook signature to ensure the event is authentic.

Write (12)​

Create or send data.

ToolWhat it does
create_invoiceCreate a draft PayPal invoice.
create_orderCreate a PayPal order with CAPTURE or AUTHORIZE intent.
create_payoutCreate a PayPal payout batch to send money to multiple recipients via email, phone, or PayPal ID.
create_planCreate a billing plan for subscriptions.
create_productCreate a catalog product in PayPal.
create_subscriptionCreate a PayPal subscription for recurring payments.
create_webhookCreate a PayPal webhook to receive event notifications at your URL.
provide_dispute_evidenceProvide evidence for a PayPal dispute such as tracking info or proof of delivery.
reauthorize_paymentReauthorize a PayPal payment to extend the authorization period.
record_invoice_paymentRecord an external payment on a PayPal invoice (e.g., cash, check, bank transfer).
send_dispute_messageSend a message to the buyer or PayPal about a dispute.
send_invoiceSend a PayPal draft invoice to recipients via email.

Delete or overwrite (28)​

Remove or replace existing data.

ToolWhat it does
accept_dispute_claimAccept a PayPal dispute claim and issue a refund to the buyer.
acknowledge_return_itemAcknowledge receipt of a returned item in a PayPal dispute.
activate_planActivate an inactive PayPal billing plan to make it available for subscriptions.
activate_subscriptionActivate a suspended PayPal subscription to resume billing.
authorize_orderAuthorize payment for an approved PayPal order.
cancel_invoiceCancel a sent PayPal invoice.
cancel_payout_itemCancel an unclaimed PayPal payout item.
cancel_subscriptionCancel a PayPal subscription permanently.
capture_authorized_paymentCapture funds from an authorized PayPal payment.
capture_orderCapture payment for an approved PayPal order.
capture_subscription_paymentCapture outstanding balance on a PayPal subscription.
confirm_orderConfirm a PayPal order with a specific payment source before capture or authorization.
deactivate_planDeactivate a PayPal billing plan.
delete_invoiceDelete a PayPal draft invoice.
delete_webhookDelete a PayPal webhook.
escalate_disputeEscalate a PayPal dispute to a claim for PayPal to investigate and decide.
make_dispute_offerMake an offer to resolve a PayPal dispute with refund, return, or replacement.
refund_captured_paymentRefund a captured PayPal payment.
revise_subscriptionRevise a PayPal subscription to change plan, quantity, or shipping.
suspend_subscriptionSuspend a PayPal subscription to temporarily stop billing.
update_invoiceFully update a PayPal draft invoice.
update_orderUpdate a PayPal order's purchase_units using JSON Patch operations before capture.
update_planUpdate a PayPal billing plan using JSON Patch operations.
update_plan_pricingUpdate pricing for a PayPal billing plan.
update_productUpdate a PayPal catalog product using JSON Patch operations.
update_subscriptionUpdate a PayPal subscription using JSON Patch operations.
update_webhookUpdate a PayPal webhook URL or event subscriptions using JSON Patch operations.
void_authorized_paymentVoid an authorized PayPal payment to release the hold on buyer's funds.
⌘J