# PayPal

[Paypal](https://www.paypal.com/) is an American online payment provider available worldwide and
one of the few that does not charge a subscription fee.

:::{note}
While PayPal is available in [over 200 countries/regions](https://www.paypal.com/webapps/mpp/country-worldwide), only [a selection of currencies are
supported](https://developer.paypal.com/docs/reports/reference/paypal-supported-currencies).
:::

(payment-providers-paypal-configuration-paypal)=

## Configuration in PayPal

1. [Log into your PayPal Developer Dashboard](https://developer.paypal.com/dashboard/).
2. Click {guilabel}`Apps & Credentials` and click {guilabel}`Create App`.
3. Enter an {guilabel}`App Name` and click {guilabel}`Create App`.
4. Copy the {guilabel}`Client ID` and {guilabel}`Secret` and save them for
   {ref}`later <payment_providers/paypal/configuration-odoo>`.

:::{important}
If you use customer names or addresses that include accented or non-Latin characters, you
**must** configure the encoding format of the payment request sent by Odoo to PayPal to avoid
transaction failures without notice. To do so, access the [PayPal button language encoding
setting](https://www.paypal.com/cgi-bin/websrc?cmd=_profile-language-encoding), click
{guilabel}`More Options`, and set the {guilabel}`Encoding` field to {guilabel}`UTF-8`.

If you are trying PayPal as a test, access your {ref}`PayPal Sandbox account
<payment_providers/paypal/testing>` and [configure the encoding format for your sandbox account](https://sandbox.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-language-encoding).
:::

:::{tip}
For encrypted website payments & EWP_SETTINGS errors, please check the [PayPal documentation](https://developer.paypal.com/docs/online/).
:::

(payment-providers-paypal-configuration-odoo)=

## Configuration in Odoo

1. {ref}`Navigate to the payment provider PayPal <payment_providers/add_new>`.
2. In the {guilabel}`Credentials` tab, enter the {guilabel}`Email` linked to your PayPal account,
   then fill in the {guilabel}`Client ID` and {guilabel}`Client Secret` fields with the values you
   saved at the step {ref}`payment_providers/paypal/configuration-paypal`.
3. Click {guilabel}`Generate your webhook` to create the {guilabel}`Webhook ID`.
4. Set the {guilabel}`State` field to {guilabel}`Enabled`, and make sure the PayPal payment provider
   is {guilabel}`Published`.
5. Configure the remaining options as desired.

(payment-providers-paypal-testing)=

## Testing

PayPal provides two sandbox accounts that you can use to simulate live transactions:

- A business account (to use as the merchant account, e.g., `ab-1abc12345678@business.example.com`);
- A default personal account (to use as the shopper account, e.g.,
  `ba-9cba87654321@personal.example.com`).

To test the PayPal payment workflow in Odoo:

1. Log into the [Paypal Developer Site](https://developer.paypal.com/) using your PayPal
   credentials and go to {menuselection}`Testing Tools --> Sandbox Accounts`.
2. Click the {icon}`fa-ellipsis-v` ({guilabel}`ellipsis`) icon next to the sandbox business account
   and select {guilabel}`View/Edit account`.
3. Copy the {guilabel}`Email`, {guilabel}`Client ID`, and {guilabel}`Secret` and save them for the
   next step.
4. In Odoo, {ref}`configure the PayPal payment provider <payment_providers/paypal/configuration-odoo>`
   with the values saved at the previous step and set the {guilabel}`State` field to
   {guilabel}`Test Mode`.

You can then run a test transaction from Odoo using the sandbox personal account.

:::{seealso}
- {ref}`payment_providers/test-mode`
- {doc}`../payment_providers`
:::