Bank Client API Quick Start

This guide obtains an access token and makes the first authenticated request to retrieve your organization's accounts.

Before you start

You need:

the Bank Client API base URL for your environment;

the username assigned to your organization;

the matching secret.

The examples use shell variables. Replace every value in angle brackets.

1. Set the base URL

The base URL includes the Merchant service path:

2. Request an access token

The response contains the bearer token and its lifetime:

{
  "accessToken": "<token>",
  "tokenType": "Bearer",
  "expiresIn": 3600
}

Store the token for the next request:

Keep credentials and tokens in server-side systems. Do not expose them in browser or mobile application code.

3. List your accounts

The response is an array of accounts that belong to the authenticated organization. Each account includes its Framnex identifier, currency, balance, state, and available payment credentials.

[
  {
    "id": "<account-id>",
    "clientId": "<organization-client-id>",
    "currency": "EUR",
    "amount": 0,
    "state": "<account-state>",
    "credentials": []
  }
]

Store the account identifiers that your integration needs. Framnex identifiers and your internal identifiers are different values.

4. Retrieve one account

You can now use your accounts with the exchange-rate and outgoing-transfer endpoints. Configure webhooks before you create production transfers so that your system can process asynchronous state changes.

Quick Start

Bank Client API Quick Start#

Before you start#

1. Set the base URL#

2. Request an access token#