> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/paypal-integration-setup.md).

# PayPal Integration Setup

### Getting Started

Use this guide to connect PayPal to your BalkanID tenant. You will need credentials from the PayPal Developer Dashboard and access to the Integrations section in BalkanID.

{% hint style="info" %}
BalkanID reads the staff users of your PayPal business account and the account roles assigned to them. Your PayPal business account must have access to PayPal's User Management API.
{% endhint %}

#### Requirements:

Before you begin, collect the following values from PayPal:

* **Client ID**
* **Client Secret**
* **Environment (production or sandbox)**

### Configure PayPal within your BalkanID tenant

1. To find the Client ID and Client Secret, sign in to the [PayPal Developer Dashboard](https://developer.paypal.com/dashboard/) using your PayPal business account.
2. Navigate to **Apps & Credentials** and select **Live**. Select **Sandbox** instead if you are connecting a test account.
3. Click **Create App**, enter an app name, select **Merchant** as the app type, then create the app.
4. Copy the **Client ID** and **Client Secret** from the app's details page.
5. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FTBZfesY12fWbGZZdS7r1%2Fpaypal-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Add integration</p></figcaption></figure></div>

6. Search for PayPal, select it, and click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FpFbiulYw9jBKcGGFd8oa%2Fpaypal-connect-application.png?alt=media" alt="The Connect a new application step with PayPal searched for and selected"><figcaption><p>Connect a new application</p></figcaption></figure></div>

7. Under **Select Extraction Type**, keep **Direct Configuration** selected and paste your **Client ID** and **Client Secret**. Leave **Environment (production or sandbox)** set to `production`, or change it to `sandbox` if you created your app under Sandbox. Click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FP7Jeejyt8VU5aT0BPtiX%2Fpaypal-direct-configuration.png?alt=media" alt="The Direct Configuration credential fields for PayPal: Client ID, Client Secret and Environment"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

8. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step showing reviewer settings and fulfillment options"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

9. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/paypal-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.