# PayPal

<!-- BEGIN GENERATED:intro -->

The PayPal connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for PayPal.

To create a new PayPal source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for PayPal-specific configuration and networking. For the complete property reference, see the [official PayPal driver documentation ↗](https://cdn.cdata.com/help/BPK/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟢 Generally available |
| Batch syncs | 🟢 Generally available |
| Incremental | 🟢 Generally available |
| [OAuth 2.0 authentication](#oauth-20-authentication) | 🟢 Generally available |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`Schema` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_Schema.htm) | Mandatory | The type of schema to use. | `SOAP` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_InitiateOAuth.htm) | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | `REFRESH` |
| [`OAuthClientId` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_OAuthClientId.htm) | Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_OAuthClientSecret.htm) | Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
| [`Password` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_Password.htm) | Recommended | Specifies the password of the authenticating user account. | — |
| [`Signature` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_Signature.htm) | Recommended | The signature required to use the SOAP API. | — |
| [`User` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_User.htm) | Recommended | Specifies the user ID of the authenticating PayPal user account. | — |
| [`UseSandbox` ↗](https://cdn.cdata.com/help/BPK/jdbc/RSBpaypal_p_UseSandbox.htm) | Recommended | A Boolean value indicating if you are using a Sandbox account. | `FALSE` |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) for details.

| Domain  | Required |
|--- |--- |
| api-3t.paypal.com | If `Schema=SOAP` (default) AND `UseSandbox=FALSE` (default) |
| api.paypal.com | If `Schema=REST` AND `UseSandbox=FALSE` (default) |
| paypal.com | If `Schema=REST` AND `UseSandbox=FALSE` (default) |
| api-3t.sandbox.paypal.com | If `Schema=SOAP` (default) AND `UseSandbox=TRUE` |
| api.sandbox.paypal.com | If `Schema=REST` AND `UseSandbox=TRUE` |
| sandbox.paypal.com | If `Schema=REST` AND `UseSandbox=TRUE` |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:oauth -->

## OAuth 2.0 authentication

This connector supports OAuth 2.0 authentication. Follow the [OAuth 2.0 guidance for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#oauth-20-authentication) to configure and authorize the connection.

<!-- END GENERATED:oauth -->