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

Home

Use Framnex APIs to access accounts, exchange rates, transfers, 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.

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 a client;
open, list, and retrieve client accounts;
request an exchange rate between accounts;
create and track outgoing transfers;
register a webhook URL and inspect or retry webhook deliveries.
Start with POST /baas/Clients, then open an account with POST /baas/Accounts.

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 an exchange rate between accounts;
create and track outgoing transfers;
upload, list, and download transfer documents;
register a webhook URL and inspect or retry webhook deliveries.
Start by listing your accounts with GET /integration/accounts.

Common integration steps#

1
Get credentials
Obtain a username and its matching secret for the target environment. The secret field name depends on the API. Keep credentials in your server-side application.
2
Request an access token
Exchange the client 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
Subscribe to webhooks
Register a webhook URL before creating production transfers. Use webhook deliveries to track asynchronous changes.

Need help?#

Contact your Framnex implementation representative if you need credentials or help choosing the correct integration model.
Modified at 2026-09-22 09:04:34
Built with