Bank Client API overview#
The Bank Client API is for an organization that operates its own Framnex accounts. The authenticated organization is the account owner and acts on its own behalf.Use the Bank Client API when you need to:list and retrieve your organization's accounts;
request exchange rates between those accounts;
create and track outgoing transfers;
upload, list, or download supporting transfer documents;
receive and inspect webhook deliveries.
Resource model#
1.
Account represents one of your organization's accounts, including its currency, balance, state, and payment credentials.
2.
Exchange rate provides a rate between a sell account and a buy account.
3.
Transfer represents an outgoing payment and its current state.
4.
Transfer document is a supporting file that can be uploaded or downloaded when a transfer flow requires documentation.
5.
Webhook delivery reports asynchronous changes and can be inspected or retried.
Authentication#
Exchange the assigned username and secret at POST /integration/auth/token. Send the returned access token with protected requests:Tokens expire. Request a new token based on the expiresIn value returned by the authentication endpoint.Typical flow#
2.
List your accounts and store the account identifiers that your integration uses.
3.
Request an exchange rate if the source and destination currencies differ.
4.
Create an outgoing transfer.
5.
Use transfer reads and webhook deliveries to track the final state.
6.
Upload supporting documents when the transfer process requires them.
Next step#
Modified at 2026-09-21 18:01:20
