> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/paypal.md).

# PayPal

Integration with PayPal for reading transaction history and invoices.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| PayPal    | Credentials    |

#### PayPal

Connect to PayPal with REST app credentials (client ID and secret). Reads transaction history and invoices.

**Set up in PayPal**

1. Sign in to the PayPal Developer Dashboard.
2. Under Apps & Credentials, create a REST API app (or open an existing one) for the Live or Sandbox environment.
3. Copy the app's Client ID and Secret.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **PayPal**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                               |
| ------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Client ID     | Yes                      | Your PayPal REST app client ID. Create an app under Developer Dashboard > Apps & Credentials. [Provider instructions](https://developer.paypal.com/dashboard/applications). |
| Client Secret | Yes                      | The client secret for your PayPal REST app. [Provider instructions](https://developer.paypal.com/dashboard/applications).                                                   |
| Sandbox       | Optional / as applicable | Connect to the PayPal sandbox environment instead of production. Enable this to use sandbox app credentials for testing.                                                    |

**Provider documentation:** [Setup reference](https://developer.paypal.com/api/rest/).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **PayPal** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Transactions

List PayPal transactions within a date range.

**Inputs**

| Field       | Type     | Required | Description                                                                                         |
| ----------- | -------- | -------- | --------------------------------------------------------------------------------------------------- |
| Start Date  | datetime | Yes      | Start of the date range. The range must not exceed 31 days.                                         |
| End Date    | datetime | Yes      | End of the date range. The range must not exceed 31 days.                                           |
| Max Results | integer  | No       | Maximum number of transactions to return (1-1000). Pages are fetched automatically up to this many. |

**Outputs**

| Field           | Type    | Description                                                 |
| --------------- | ------- | ----------------------------------------------------------- |
| Transactions    | array   | Array of PayPal transaction detail objects.                 |
| Transaction IDs | array   | IDs of the returned transactions.                           |
| Count           | integer | Number of transactions returned.                            |
| Total Items     | integer | Total number of transactions PayPal reports for this query. |
| Truncated       | boolean | True if more transactions exist than were returned.         |

#### List Invoices

List invoices from your PayPal account.

**Inputs**

| Field       | Type    | Required | Description                                                                                     |
| ----------- | ------- | -------- | ----------------------------------------------------------------------------------------------- |
| Max Results | integer | No       | Maximum number of invoices to return (1-1000). Pages are fetched automatically up to this many. |

**Outputs**

| Field       | Type    | Description                                             |
| ----------- | ------- | ------------------------------------------------------- |
| Invoices    | array   | Array of PayPal invoice objects.                        |
| Invoice IDs | array   | IDs of the returned invoices.                           |
| Count       | integer | Number of invoices returned.                            |
| Total Items | integer | Total number of invoices PayPal reports for this query. |
| Truncated   | boolean | True if more invoices exist than were returned.         |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/paypal.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
