PayPal

Let your agents create and capture PayPal orders, refund captured payments, draft and send invoices, manage subscriptions and search your transaction history.

Connection

Authentication: API key (Client ID:Secret).
Required settings:
- Environment — api-m.sandbox for a developer sandbox account, api-m in production.

On developer.paypal.com (log in with your PayPal business account): Apps & Credentials → choose Sandbox or Live (top toggle) → Create App (type Merchant) → name it “Atako”. In the app’s Features, keep Accept payments and tick Invoicing, Transaction Search and Subscriptions. Copy the Client ID and the Secret and paste them joined by a colon: client_id:secret. Then set the Environment field to match (api-m.sandbox for sandbox credentials, api-m for live ones). Transaction Search data can take a few hours to appear after enabling it.See PayPal’s documentation.

Read actions (9)

Action	Description
`get_capture`	Get a captured payment by ID: amount, status, PayPal fee and net amount (seller_receivable_breakdown).
`get_invoice`	Get an invoice by ID (INV2-…): status, recipients, items, amounts, due amount and payments.
`get_order`	Get an order by ID: status (CREATED, APPROVED, COMPLETED…), purchase units, payer and the captures/authorizations it produced.
`get_refund`	Get a refund by ID: amount, status (COMPLETED, PENDING, FAILED…) and note to payer.
`get_subscription`	Get a subscription by ID (I-…): status, plan, subscriber, billing_info (next billing time, failed payments).
`list_invoices`	List invoices, newest first, page_size 1-100 (default 20); total_required adds total_items/total_pages.
`list_plans`	List subscription plans, optionally for one product_id; page_size 1-20 (default 10).
`list_transactions`	List account transactions between start_date and end_date (RFC 3339 with seconds, e.g. 2026-09-01T00:00:00Z; at most 31 days apart, last 3 years, new transactions show up within 3 hours); page_size 1-500 (default 100).
`search_invoices`	Search invoices by recipient email, invoice number, statuses (up to 5), currency, invoice or due date range (YYYY-MM-DD start/end); page_size 1-100.

Write actions (7)

Action	Description
`cancel_subscription`	Cancel a subscription for good (no reactivation); PayPal answers 204 with no body.
`capture_order`	Capture the payment of an APPROVED order (intent CAPTURE). The capture id is in purchase_units[].payments.captures[].id — use it for refund_capture.
`create_invoice`	Create a DRAFT invoice: detail.currency_code, primary_recipients[].billing_info (email_address, name), items (name, quantity as a string, unit_amount {currency_code, value}). Send it with send_invoice.
`create_order`	Create a checkout order with 1-10 purchase units; the payer approves it at the links[rel=payer-action] URL, then call capture_order (intent CAPTURE). Intent AUTHORIZE only holds funds — authorizing/capturing them is not exposed here. amount.value is a decimal string (“10.00”).
`refund_capture`	Refund a captured payment — in full when amount is omitted, partially otherwise (same currency as the capture). Pass request_id to retry safely.
`send_invoice`	Send a DRAFT invoice (or schedule it when its invoice_date is in the future): PayPal emails the recipient unless send_to_recipient is false (then share the invoice link yourself).
`suspend_subscription`	Suspend (pause) an ACTIVE subscription; PayPal answers 204 with no body.

Permissions

Every action above must be explicitly granted to an agent before it can be used. See Permissions for the grant model and Security for how credentials are protected.

Last reviewed against the provider API: September 2026.

Using integrations

Communication

Scheduling

Project management

Docs & design

Files & storage

CRM & sales

Customer support

HR & recruiting

Commerce & billing

Developer tools

Observability & analytics

AI & media

Connection

Read actions (9)

Write actions (7)

Permissions

​Connection

​Read actions (9)

​Write actions (7)

​Permissions

Connection

Read actions (9)

Write actions (7)

Permissions