Introduction

The FinologeeBKO API is a RESTful API that allows full automation of all processes available in the FinologeeBKO 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 FinologeeBKO API is organized into three categories:

---

Environments

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

---

OpenAPI files

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

• Authentication API
• Payments API
• Invoicing API

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

---

Counterparty management via API

The Payments API supports full counterparty lifecycle management, enabling external systems to create, approve, and organize counterparties without requiring manual intervention in the FinologeeBKO user interface.

Counterparty approval via API

External systems can approve counterparties through the Payments API. This enables integration scenarios where counterparty validation and approval occur within an external system before or alongside FinologeeBKO's own controls.

The typical workflow for API-driven counterparty approval is:

1. The external system creates a counterparty in FinologeeBKO via the API. The counterparty is created with a Pending status and undergoes IBAN and BIC validation at creation time.
2. The external system completes its own internal approval process.
3. The external system calls the counterparty approval endpoint in the Payments API to approve the counterparty in FinologeeBKO.
4. The counterparty status changes to Active and becomes available for use in payments.

📘

IBAN and BIC validation

Creating a counterparty via API before external approval allows FinologeeBKO to validate the IBAN and BIC at the point of creation. This ensures account details are confirmed accurate before the approval step completes.

⚠️

Four-eyes principle

API-driven counterparty approval must respect the four-eyes principle. The API credentials used to approve a counterparty must belong to a different user or service account than the one that created it. The system enforces this restriction regardless of the approval method used.

Counterparty grouping via API

External systems can assign counterparties to groups through the Payments API, enabling programmatic organization of counterparties without manual UI interaction.

With counterparty grouping via API, external systems can:

• Assign newly created counterparties to one or more groups as part of an automated onboarding flow
• Mirror group structures from external systems into FinologeeBKO counterparty groups
• Manage group membership in bulk for large counterparty portfolios

Group assignments made via API take effect immediately and are visible in the FinologeeBKO user interface. Counterparty group membership follows the same access control scoping as counterparties created through the UI.

---

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].