konfipay help center

Set up PayPal account (REST)

A prerequisite for using the REST interface is that your PayPal account is a business account. If this is not the case, PayPal will display an error message stating that the necessary authorizations are not available to generate API keys.

For new PayPal accounts, setting up via the REST interface is now the standard method. It is recommended over the older SOAP procedure, which PayPal has deprecated.

To set up via REST, you need the Client ID and the Client Secret of your PayPal account. You can obtain this as follows:

1

First navigate to: https://developer.paypal.com/home and click on Log in to Dashboard.

image-20260127-133358.png

2

Log in with your PayPal access data. You may be prompted to enter a second factor.

grafik-20231123-181928.png

3

Make sure that you create API keys for the live environment.

image-20260127-133540.png

4

Click on Apps & Credentials.

image-20260127-133706.png

5

Click on Create App.

image-20260127-133726.png

6

Assign an app name (e.g. konfipay) and confirm the process with Create App.

image-20260127-133811.png

7

PayPal has created the API credentials.

Note: Stay logged in to PayPal until the setup is complete and do not leave this view!

For the next step, you must continue in konfipay. We recommend opening konfipay in another browser tab or window.

image-20260127-134005.png

8

Open konfipay in a separate tab or browser window (https://portal.konfipay.de or https://portal.konfipay.ch)

To set up the PayPal account in konfipay, select "PayPal" > "PayPal accounts" in the navigation bar on the left, then click Add in the toolbar at the top.

Then set up the account as shown in the dialog, starting by assigning a name.

The field Requested period determines how far into the past the initial transaction retrieval should go. The maximum retrieval period is 1 year.

Steps 9 and 10 show you how to enter the Client ID and Client Secret from PayPal in the appropriate places here.

grafik-20231124-102759.png
grafik-20261015-082537.png

9

Switch to PayPal.
Client ID: Click on the copy symbol next to client ID.

In konfipay, add the ID in the field Client ID.

image-20260127-134335.png

10

Client Secret: Click on the copy symbol next to “Secret key 1”.

In konfipay, add the key in the field Client Secret.

image-20260127-134355.png

11

Scroll down to Features on the PayPal website and check the box next to Transaction Search. Confirm the process with Save Changes.

image-20260127-134518.png

12

You can now close PayPal and click Save in konfipay to complete the setup.

Please note: Step 11 is mandatory in order to be able to retrieve transactions via the PayPal API. It can take up to 12 hours before konfipay can retrieve transactions from PayPal.

Connection test

Before saving a PayPal account, you can run a connection test by clicking Connection test. This lets you check that the data is correct and that a connection can be established before the account is created.

After saving, konfipay automatically runs a connection test for all configured REST accounts. In the account overview (PayPal > PayPal accounts), the Connection test column shows a green checkmark (connection successful) or a red X (connection failed) for each account. If there is an error, please check that the Client ID and Client Secret have been entered correctly.

Sandbox environment

When creating an account, you can enable the Use sandbox environment option. In this mode, konfipay connects to the PayPal sandbox instead of the live environment. This is intended exclusively for test purposes — no real transactions exist in the sandbox. For production use, this option must not be enabled.

Setting the time zone

PayPal delivers all timestamps in UTC. Using the Set time zone option in the setup dialog, you can select a time zone to which konfipay will automatically convert the timestamps. You can specify whether the conversion should apply to the display in the user interface and/or to the API output. Without this setting, all timestamps are displayed and output in UTC.

Updating the Client Secret

If you renew your Client Secret in PayPal, you must also update it in konfipay. To do this, select the relevant account in the account overview (PayPal > PayPal accounts) and click Change Client Secret in the toolbar. The new secret is saved after validation against the PayPal API.

The Client ID cannot be changed once an account has been created. If an incorrect Client ID was entered, the account must be deleted and set up again.