About the Payt category

o.plokha · May 16, 2025, 7:25am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Payt API Reference

Connector package documentation

1. Setting up HTTP Client Payt

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Payt HTTP Client as PlatForm and click next step
Fill in the Base URI, API Key and API Secret.
(See the Payt Authentication Documentation for more information)
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Payt

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Payt Subscriber” as the subscriber.
Select the entity you want to subscribe to from Payt.
Add any request parameters needed to subscribe to the entity.
Select the Payt HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Payt.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Payt documentation on building this connector, so you can easily use the connector based on Payt API Reference.

Entity

The entity you want to subscribe to Payt. Please refer to the entities from Payt API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Payt API Reference.

Please look at the example below on how to fill request parameters when we want retrieve an administration debtors by subscribing “Get administration debtor by id” entity.

From the end point, we can see that we need to set the “id” as a path and “administration_id” as a query. That is why we set them inside the Request Parameters.

Alumio will then make a request to Payt with the URL
/v1/debtors/3349059?administration_id=2813

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

HTTP Client

The HTTP Client configuration you will use to access Payt.

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Payt Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Payt entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method and HTTP Patch method on submitting data to Payt.

Entity

We support publishing to all Payt endpoints.
Please refer to Payt API Reference page.

For example, we want to create administrationq contacts. Please select “Post” as the Method and “Create or update administration contacts”.

From the documentation, we can see that we need to set a body parameters. That is why we set the body parameters inside the payload key in the data.

Alumio will send an API request to Payt with URL /v1/contacts

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.