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

# Paypal Sandbox

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (OAuth) | ✅ |
> | Credentials auto-refresh | ✅ |
> | Auth parameters validation | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ 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] ✅ 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] ✅ 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 | ✅ |

### Others

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

## 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).

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

## 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-sandbox.mdx)

## 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-sandbox.mdx)


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