> For the complete documentation index, see [llms.txt](https://help.orderdesk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.orderdesk.com/integration-setup-guides/payment-gateways/paypal-integration.md).

# PayPal Integration

The Order Desk PayPal integration can be used to refund your payments. If PayPal is your shopping cart, you can also configure the integration to download your orders from PayPal directly into Order Desk.

### Setup

To set up your PayPal integration, you will need to generate some API keys inside of your PayPal account and paste them into the Order Desk integration. Please note that API keys are not available on personal PayPal accounts. You will need to upgrade to a business account.

Click the **Profile** button at the top of your screen and select **Profile and settings**:

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FyRLn0nfsnDf4EzOAFZaQ%2Flegacy-cb84754b4b24788e5547.png?alt=media)

Then click **My Selling Tools** in the sidebar and click Update next to the **API access** section.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FK47cd8UcoV0x73XaC2cR%2Flegacy-9b3ee0dc6bbed74d63d3.png?alt=media)

Scroll to the **NVP/SOAP API Integration** and click **Request API credentials** or **View API Signature**.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2Fkw5xgUWCU5GYU8qWIy01%2Flegacy-cca5701b2e433fb69e1f.png?alt=media)

On the next screen you will select **Request API signature** and click **Agree and Submit**. If you already created a signature you can use the details found on this page. If you’ve previously created a certificate, however, you’ll have to remove the certificate in order to create a signature. Be sure the certificate isn’t being used for anything since it will no longer work.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FYHzVE7J5gbw4S1ZxkURD%2Flegacy-05792472cdcf14e060ed.png?alt=media)

Finally copy and paste the the username, password, and signature into the Order Desk setup page.

### Payments

If the transaction took place with the PayPal gateway, you’ll see a refund/capture box on the order detail page.

*Refer to the* [*Refunding and Capturing Payments*](/guided-walkthroughs/shipping-fulfillment-and-returns/how-to-refund-and-capture-payments.md) *article to read more about Order Desk’s payment processing capabilities.*

### Importing Orders

If you’ve enabled the PayPal Order Import feature, you’ll be able to schedule imports of your orders from PayPal into Order Desk. If you want to import your PayPal orders faster, put the provided IPN URL into the [IPN settings page](https://www.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-ipn-notify) in PayPal. Whenever the IPN hits Order Desk it will schedule an import at the next appointment run (usually within 5 minutes).

Order Desk downloads ALL transactions from PayPal (except transfer transactions). The integration saves a lot of order metadata so you may want to set up some rules based on your particular order needs.


---

# 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://help.orderdesk.com/integration-setup-guides/payment-gateways/paypal-integration.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.