> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Paypal

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                           | Status |
    | ------------------------------- | ------ |
    | Pre-built authorization (OAuth) | ✅      |
    | Credentials auto-refresh        | ✅      |
    | Auth parameters validation      | ✅      |
    | Pre-built authorization UI      | ✅      |
    | Custom authorization UI         | ✅      |
    | Expired credentials detection   | ✅      |
  </Accordion>

  <Accordion title="✅ Read & write data">
    | Tools                                     | Status                         |
    | ----------------------------------------- | ------------------------------ |
    | Pre-built integrations                    | ✅                              |
    | API unification                           | ✅                              |
    | 2-way sync                                | ✅                              |
    | Webhooks from Nango on data modifications | ✅                              |
    | Real-time webhooks from 3rd-party API     | 🚫 (time to contribute: \<48h) |
    | Proxy requests                            | ✅                              |
  </Accordion>

  <Accordion title="✅ Observability & data quality">
    | Tools                   | Status |
    | ----------------------- | ------ |
    | HTTP request logging    | ✅      |
    | End-to-end type safety  | ✅      |
    | Data runtime validation | ✅      |
    | OpenTelemetry export    | ✅      |
    | Slack alerts on errors  | ✅      |
    | Integration status API  | ✅      |
  </Accordion>

  <Accordion title="✅ Customization">
    | Tools                              | Status                         |
    | ---------------------------------- | ------------------------------ |
    | Create or customize use-cases      | ✅                              |
    | Pre-configured pagination          | 🚫 (time to contribute: \<48h) |
    | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
    | Per-customer configurations        | ✅                              |
  </Accordion>
</AccordionGroup>

### Others

| Function name                  | Description                                                                                                            | Type                                           | Source code                                                                                                                         |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `activate-subscription`        | Reactivate a suspended subscription.                                                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/activate-subscription.ts)        |
| `add-order-tracking`           | Add shipment tracking information to a captured order.                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/add-order-tracking.ts)           |
| `authorize-order`              | Authorize an order.                                                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/authorize-order.ts)              |
| `cancel-invoice`               | Cancel a sent invoice.                                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/cancel-invoice.ts)               |
| `capture-authorized-payment`   | Capture funds for a previously authorized payment.                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/capture-authorized-payment.ts)   |
| `capture-order`                | Capture an order.                                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/capture-order.ts)                |
| `confirm-order-payment-source` | Confirm the payment source for an order to move it toward payer approval, used in server-driven checkout integrations. | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/confirm-order-payment-source.ts) |
| `create-invoice`               | Create an invoice.                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/create-invoice.ts)               |
| `create-order`                 | Create an order.                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/create-order.ts)                 |
| `create-plan`                  | Create a billing plan.                                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/create-plan.ts)                  |
| `create-product`               | Create a catalog product.                                                                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/create-product.ts)               |
| `create-subscription`          | Create a subscription.                                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/create-subscription.ts)          |
| `deactivate-plan`              | Deactivate a billing plan so it can no longer be subscribed to.                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/deactivate-plan.ts)              |
| `delete-invoice`               | Delete a draft invoice that has not yet been sent.                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/delete-invoice.ts)               |
| `get-authorization`            | Retrieve details for an authorized payment.                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-authorization.ts)            |
| `get-capture`                  | Retrieve a capture.                                                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-capture.ts)                  |
| `get-invoice`                  | Retrieve an invoice.                                                                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-invoice.ts)                  |
| `get-order`                    | Retrieve an order.                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-order.ts)                    |
| `get-plan`                     | Retrieve a billing plan.                                                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-plan.ts)                     |
| `get-product`                  | Retrieve a catalog product                                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-product.ts)                  |
| `get-refund`                   | Retrieve details for a refund.                                                                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-refund.ts)                   |
| `get-subscription`             | Retrieve a subscription.                                                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/get-subscription.ts)             |
| `list-disputes`                | List disputes.                                                                                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/list-disputes.ts)                |
| `list-invoices`                | List invoices.                                                                                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/list-invoices.ts)                |
| `list-plans`                   | List billing plans.                                                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/list-plans.ts)                   |
| `list-products`                | List catalog products.                                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/list-products.ts)                |
| `record-invoice-payment`       | Record an external (offline) payment against an invoice, e.g. cash or bank transfer.                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/record-invoice-payment.ts)       |
| `refund-capture`               | Refund a capture.                                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/refund-capture.ts)               |
| `send-invoice`                 | Send an invoice.                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/send-invoice.ts)                 |
| `update-order-tracking`        | Update an existing tracking record on a PayPal order.                                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/update-order-tracking.ts)        |
| `update-order`                 | Update an order with a JSON Patch before it is captured or authorized (e.g. amount, description, shipping address)     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/update-order.ts)                 |
| `update-plan-pricing`          | Update the pricing scheme of one or more billing cycles on a plan.                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/update-plan-pricing.ts)          |
| `update-product`               | Update a catalog product's description or category with a JSON Patch.                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/update-product.ts)               |
| `void-authorized-payment`      | Void, or cancel, an authorized payment so it can no longer be captured.                                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/actions/void-authorized-payment.ts)      |
| `disputes`                     | Sync disputes.                                                                                                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/syncs/disputes.ts)                       |
| `invoices`                     | Sync invoices                                                                                                          | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/syncs/invoices.ts)                       |
| `plans`                        | Sync plans.                                                                                                            | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/syncs/plans.ts)                          |
| `products`                     | Sync products.                                                                                                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/syncs/products.ts)                       |
| `subscriptions`                | Sync subscriptions.                                                                                                    | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/syncs/subscriptions.ts)                  |
| `transactions`                 | Sync transactions.                                                                                                     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/paypal/syncs/transactions.ts)                   |

## Access requirements

| Pre-Requisites    | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account  | ❓      |         |
| Paid test account | ❓      |         |
| Partnership       | ❓      |         |
| App review        | ❓      |         |
| Security audit    | ❓      |         |

## Setup guide

*No setup guide yet.*

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/paypal.mdx)</Note>

## Useful links

* [How to register an Application](https://developer.paypal.com/dashboard/applications/live)
* [OAuth-related docs](https://developer.paypal.com/api/rest/authentication/)
* [List of OAuth scopes](https://developer.paypal.com/api/rest/requests#:~:text=if%20not%20provided.-,scope,-Optional)
* [Paypal API docs](https://developer.paypal.com/api/rest/)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/paypal.mdx)</Note>

## API gotchas

* Specific parameters for the OAuth flow can be used for testing according to the [documentation](https://developer.paypal.com/tools/sandbox).

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/paypal.mdx)</Note>