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

# PayPal

> Connect PayPal to your Atako agents — 9 read and 7 write actions.

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.

<Note>
  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](https://developer.paypal.com/dashboard/applications).
</Note>

## 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](/integrations/permissions) for the grant model and [Security](/integrations/security) for how credentials are protected.

***

*Last reviewed against the provider API: September 2026.*


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