How does the Payt Post API work and what can you use it for?

What is the Post API?

The Post API is a technical integration that allows you to create or update data in Payt from an external source. This includes, for example, the automatic submission of customers, invoices and payments.

The Post API is mainly used by organisations with technical expertise (or a development partner) that want to connect Payt to their own system, without using existing accounting integrations.

An advantage of the Post API is that changes in your source system are visible in Payt within a few minutes. This makes it faster than Payt’s standard import functionality.

How does the Post API work?

The Post API works by sending HTTP POST requests to fixed Payt API endpoints. At a high level, it works as follows:

1. Your system (accounting software, CRM, or another system) prepares a POST request containing the correct data, for example a new invoice.

2. This request is sent to the appropriate API endpoint.

3. Payt validates the submitted data.

4. If the request is processed successfully, the data is created or updated in Payt.

5. Any follow-up actions (such as emails or reminders) are automatically triggered based on your settings.

If the submitted data is incorrect, the API returns an error message, for example due to missing or invalid data, which you can use to resolve the issue.