1. Guides
Framnex for Developers
  • Home
Guides
BaaS API ReferenceBank Client API ReferenceFrontOffice API Reference
Guides
BaaS API ReferenceBank Client API ReferenceFrontOffice API Reference
  1. Guides

Home

Use Framnex APIs to access accounts, exchange rates, transfers, documents, and webhook events. Choose the API based on whose accounts your integration operates.

Choose your integration model#

BaaS API
For platforms that provide financial services to their own clients. Onboard individuals or companies, open accounts for them, and operate those client accounts.
Bank Client API
For organizations that work with their own Framnex accounts. Read account data, request exchange rates, create outgoing transfers, and manage transfer documents.

What you can build#

BaaS API#

Use the BaaS API when your product serves clients of its own. A client can be an individual or a company. Your integration creates the client in Framnex and opens one or more accounts for that client.
With the BaaS API, you can:
onboard individual and business clients;
open, list, and retrieve client accounts;
request exchange rates between accounts;
create and track outgoing transfers;
register a webhook URL and inspect or retry webhook deliveries.
Start with the BaaS API Overview, then follow the Quick Start.

Bank Client API#

Use the Bank Client API when your organization is the Framnex client and operates its own accounts. This API does not onboard your clients or open accounts for them.
With the Bank Client API, you can:
list and retrieve your organization's accounts;
request exchange rates between accounts;
create and track outgoing transfers;
upload, list, and download transfer documents;
register a webhook URL and inspect or retry webhook deliveries.
Start with the Bank Client API Overview, then follow the Quick Start.

How the documentation is organized#

1
Start with the introduction
Read the Overview to choose the correct API, then use Quick Start to complete the first working flow. Authentication and Environments cover credentials, tokens, and environment configuration.
2
Use Guides for complete tasks
Guides connect several API operations into end-to-end flows such as onboarding a client, opening an account, creating a transfer, handling webhooks, and managing transfer documents.
3
Use API Reference for exact schemas
The generated reference is the source of truth for endpoint paths, request and response fields, supported types, and schema details. It is updated from the backend services.

Common integration steps#

1
Get credentials
Obtain the base URL and credentials for the target environment. Keep credentials in your server-side application.
2
Request an access token
Exchange the assigned credentials for an access token and send it as a bearer token with protected requests.
3
Make the first domain request
Onboard a client with the BaaS API, or list your organization's accounts with the Bank Client API.
4
Configure webhooks
Register a webhook URL before production transfers so your system can process asynchronous state changes.

Need help?#

Contact your Framnex implementation representative if you need credentials, environment details, or help choosing the correct integration model.

Machine-readable documentation#

A machine-readable index of this documentation is available at https://developer.framnex.com/llms.txt.
The index links to Markdown representations of documentation pages. If your client does not support the text/markdown content type, remove the .md suffix from a page URL to open the equivalent HTML version.
For example:
Markdown: https://developer.framnex.com/44444629e0.md
HTML fallback: https://developer.framnex.com/44444629e0
The HTML and Markdown representations are generated from the same published documentation. Use the live API reference for current endpoint paths, request and response schemas, and supported values.
Modified at 2026-09-29 14:34:43
Built with