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.
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. |
|
|
2 |
Log in with your PayPal access data and confirm your identity via SMS authentication if necessary. |
|
|
3 |
Make sure that you create API keys for the live environment. |
|
|
4 |
Click on Apps & Credentials. |
|
|
5 |
Click on Create App. |
|
|
6 |
Assign an app name (e.g. konfipay) and confirm the process with Create App. |
|
|
7 |
PayPal has now created the API keys. 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. |
|
|
8 |
To connect the PayPal account to konfipay, select "PayPal" > "PayPal accounts" in the navigation bar on the left, then click Then select the left option to add a REST PayPal account. |
|
|
9 |
Assign a name for the account. Steps 10 and 11 show you how to get the Client ID and Client Secret from PayPal to enter in the appropriate places here. The field |
|
|
10 |
Switch to PayPal.
In konfipay, add the ID in the field |
|
|
11 |
Client Secret: Click on the copy symbol next to “Secret key 1”. In konfipay, add the key in the field |
|
|
12 |
Scroll down to |
|
|
13 |
You can now close PayPal and click |
|
Please note: Step 12 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
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.