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

# PayPal

Configure PayPal as a payout processor on Juspay Hyperswitch to distribute funds to PayPal and Venmo accounts globally.

PayPal connects to Hyperswitch as a `PayoutProcessor` for digital wallet payouts. It supports payouts to PayPal accounts globally and Venmo accounts within the US. PayPal is also a payment gateway on Hyperswitch — the same connector handles both payments and payouts.

### Authentication

PayPal uses `BodyKey` authentication with OAuth2 client credentials. Two credentials are required.

| Credential                  | Description                                                                                 |
| --------------------------- | ------------------------------------------------------------------------------------------- |
| **Client Secret (API Key)** | PayPal app client secret. Found in the PayPal Developer Dashboard under Apps & Credentials. |
| **Client ID (Key1)**        | PayPal app client ID. Found in the PayPal Developer Dashboard under Apps & Credentials.     |

Hyperswitch uses these credentials to obtain a Bearer access token from PayPal's OAuth2 token endpoint before each API call.

### Supported Payout Methods

| Method  | Rails / Networks | Notes                                                |
| ------- | ---------------- | ---------------------------------------------------- |
| Wallets | PayPal           | Payouts to any PayPal account email address globally |
| Wallets | Venmo            | Payouts to Venmo accounts (US only)                  |

### Payout Flows

PayPal implements the following Hyperswitch payout flows:

| Flow          | Description                                       |
| ------------- | ------------------------------------------------- |
| **PoCreate**  | Creates the payout batch in PayPal's Payouts API  |
| **PoFulfill** | Executes the payout — processes the created batch |
| **PoSync**    | Retrieves the status of a payout item             |

### Common Failure Modes

**Access token fetch fails** Symptom: PayPal returns 401 on all requests. Fix: Verify the Client ID and Client Secret stored in Hyperswitch match your PayPal app credentials. Credentials are environment-specific — sandbox credentials do not work in production.

**Receiver account not found** Symptom: Payout fails with `RECEIVER_UNREGISTERED` or similar error. Fix: The recipient email must be a registered PayPal account. PayPal payouts cannot be sent to unregistered email addresses.

**Payout blocked by compliance** Symptom: Payout returns a `COMPLIANCE_VIOLATION` error. Fix: This occurs when the recipient country or payout amount triggers PayPal's compliance checks. Review PayPal's payout restrictions for the target country.

***

### Activating PayPal Payouts via Hyperswitch

#### Prerequisites

1. A PayPal Business account with Payouts API access enabled. Enable the Payouts API in the PayPal Developer Dashboard.
2. A registered Hyperswitch account, accessible from the [Hyperswitch control center](https://app.hyperswitch.io/).
3. Client ID and Client Secret from the PayPal Developer Dashboard under Apps & Credentials.

[Steps to activate a connector on the Hyperswitch control center](/integrations/connectors-integrations/activate-connector-on-hyperswitch.md)

***

Connector implementation: `crates/hyperswitch_connectors/src/connectors/paypal.rs`.


---

# 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.hyperswitch.io/integrations/connectors-integrations/payouts/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.