API and Plugins

Learn how to utilize the Payrexx API to integrate Payrexx with third-party systems such as e-commerce or CMS tools.

The abbreviation "API" stands for Application Programming Interface. It refers to a set of commands, functions, and protocols that allows one software application to interact with another system. Please use the current Payrexx API Version 1.7 .

To edit an existing API integration or create a new one, navigate to the API and Plugins section in the main menu of your Payrexx account.

If you have already created API integrations, you will see them on the right side of the window:

Active integrations of third-party systems in Payrexx

Add New API Integration

To add a new third-party system via the API, click the white "Add API Key" button at the bottom of the page:

Adding a new API Key in Payrexx

Give the integration any name and click "Add":

Assigning any name to the integration

Once the integration is created, you will find it in the list and can copy its API key, which you will then enter in the appropriate place in the third-party system you are integrating.

API Key of the newly created integration

Add New E-Commerce Integration

At the bottom of the "API and Plugins" page, various e-commerce systems such as WooCommerce, Shopify, Gambio, and many more can be connected to Payrexx:

Adding E-Commerce integrations to Payrexx

For more information on this topic, please visit the following page:

E-Commerce Systems | ENGLISH | Docs

In addition to e-commerce solutions, other software systems can also be integrated into Payrexx:

Content Management Systems (CMS) | Docs

Business Software | Docs

View Log Files

Each API integration has log files that record the communication, i.e., all API requests, between Payrexx and the respective e-commerce system, displaying any potential errors. To view the log file, simply click the "Logs" button for the respective e-commerce system:

Viewing log files of the integration with PrestaShop

You will now see a list of API requests between Payrexx and the chosen e-commerce system, in this example, PrestaShop:

Excerpt from the list of API requests

By clicking on a specific row, the details of the selected API request will appear in the right section of the window. Here is an example of an integration with PrestaShop:

Example of an API request for the integration with PrestaShop

Additional Information on API

For more information about API, refer to the Payrexx developer documentation:

OverviewDeveloper