Introduction

The LYNKS API is a RESTful API that allows full automation of all processes available in the LYNKS user interface. It exposes resources using the same terminology as the UI, making it straightforward to understand and use.

The API documentation covers the available operations, their request and response structure, error messages, and usage examples.

API categories

The LYNKS API is organized into three categories:

Category	Description
Authentication API	Describes the OAuth2 password grant flow used to retrieve a bearer token for authenticated API calls
Payments API	Manage your accounts, counterparties, and payments between them
Invoicing API	Send invoices and credit notes through the Peppol e-invoicing network

Environments

LYNKS provides sandbox and production environments, each fully isolated and secured by tenant:

Environment	URL
Sandbox	`https://test-[your-tenant].lynks.lu`
Production	`https://[your-tenant].lynks.lu`

OpenAPI files

All versions of the OpenAPI 3 files (formerly Swagger) are available for download:

You can review code examples directly in the API reference for each method, or generate a complete client application using one of the following open-source tools:

Swagger Editor: https://editor-next.swagger.io/
OpenAPI Generator: https://github.com/OpenAPITools/openapi-generator

Statement data

The Payments API provides access to bank statement data ingested by the platform. This covers account balances and transaction history sourced from connected bank accounts.

Supported statement format

The platform processes intraday bank statements in the CAMT.052.001.02 format. Statement data is reflected in account balance and transaction feeds available through the Payments API.

FX statement transaction entries

Statement transaction entries for foreign exchange payments include the following additional fields:

Exchange rate — the rate applied to the FX transaction
Original amount — the transaction amount in the original (source) currency
Original currency — the currency of the original transaction before conversion

These fields enable FX validation and reconciliation workflows when consuming statement data via the API.

Support

For assistance with API integration, contact the Finologee support team at [email protected].