PayPal is a payment method that is very popular among both merchants and consumers. PayPal allows you to reach customers all over the world.

If you set the shipping and/or billing address fields on the order object when creating a charge, these data will be sent to Paypal.

📘

Notice

There are some restrictions:

• Paypal only allows email addresses without special characters / accents, so e.g. hé[email protected] is not allowed. If an email address does not meet these requirements it will be skipped.

• PayPal requires a postal code for a shipping address. If a postal code is not present the shipping address will be skipped.

The enable recurring payments you need to have vaulting enabled on your PayPal account

🚧

Deprication of Agreements using Client Id and Client Secret

By 31.01.2025 Agreements setup with Client Id and Client Secret will not be supported anymore. Please migrate your agreement by that time by following the manual below.

Setup

Start by accessing the payment method configuration screen:

Under PayPal, make sure to enable the toggle and click continue:

This will start PayPal's onboarding flow, where you can login into your PayPal account and give our system the necessary partner permissions, allowing us to take advantage of PayPal's functionalities on your behalf.

Make sure that your PayPal account is a valid business account, and that it has vaulting enabled. This will be needed to be able to store payment tokens and perform recurring payments.

Upgrade from a Legacy Agreement

The legacy agreements do not support recurring payments. In order to upgrade, click the create new agreement button (marked in the picture below), "Use an existing agreement", and then follow the Setup steps above.

This will create a new agreement in a disabled state:

At this point it is enough to disable the old agreement and enable the new one. Note that captures and refunds will continue to work on the disabled agreement, and all new payments will use the new agreement.

Import Existing Payment Tokens

If moving from a different Payment Service Provider, you might want to import existing customers, together with their associated payment tokens. This operation can be achieved by calling the import payment method API for each individual customer. Information about the customer, as well as the payment token need to be provided. We support both vault tokens, as well as billing agreements IDs.