Create an outgoing transfer

Use this flow to create and track an outgoing transfer from one of your organization's Framnex accounts.

The exact transfer request depends on the transfer type and the capabilities enabled for your organization. Use the generated API reference as the source of truth for request fields and schemas.

Before you start

You need:

a valid Bank Client API access token;

the Framnex identifier of the source account;

the transfer details required by the current API schema;

webhooks configured if you want asynchronous status updates.

If you do not have an account identifier yet, use the Bank Client API Quick Start to list your accounts.

1. Confirm the source account

Use the account read endpoints when you need to select or validate an account:

List accounts

Get an account

2. Request an exchange rate when the flow requires one

When a flow uses different sell and buy accounts, use the exchange-rate endpoint:

Get an exchange rate

Use the generated reference page for the current request parameters and response schema.

3. Build and submit the transfer request

Create the transfer using the generated API reference:

Create an outgoing transfer

The API reference defines the currently supported transfer request types and fields. Check the live schema before you implement or change a transfer flow.

4. Track the transfer

Use the transfer read endpoints to inspect the current state:

List transfers

Get a transfer

Transfer processing can be asynchronous. Use webhook deliveries to react to state changes instead of relying only on synchronous create responses.

5. Add supporting documents when required

Some transfer flows can require supporting documents. Use Transfer documents in the Guides folder for the upload, list, and download operations.

Before production transfers, continue with Handle webhooks.

Before you start#

1. Confirm the source account#

2. Request an exchange rate when the flow requires one#

3. Build and submit the transfer request#