Skip to content
Company Fund Allocation

Company Fund Allocation

Initiate an internal company fund transfer, moving a given amount and currency between the specified source and destination accounts.

Request parameters

  • Required: transfer_type (transfer type), from_type (source party type), from_main_account (source main account), from_main_account_type (source main account type), from_account_id (source account ID), to_type (destination party type), to_main_account (destination main account), to_main_account_type (destination main account type), to_account_id (destination account ID), allocation_channel (transfer channel), currency (currency), amount (amount), postscript (memo)
  • See the field definitions for each field's format, allowed values, and business meaning.

Risk warning

This operation may change real funds, positions, or transaction state. Confirm the target record and parameters before calling.

Result

On success the operation completes; refer to the 200 response for the resulting state and data.

POSThttps://b-api.lbkrs.com/atm/whale/transfer

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

atm.company_fund_allocation_operation

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

transfer_typestringrequired

Transfer type.

Allowed values: 1 Bank-to-bank transfer, 2 Settlement account recharge, 3 Settlement account withdrawal, 4 Settlement-to-settlement transfer

Values
1
Bank-to-bank transfer
2
Settlement account recharge
3
Settlement account withdrawal
4
Settlement-to-settlement transfer
from_typestringrequired

Source party type.

Allowed values: 1 Bank, 2 Whale settlement channel

Values
1
Bank
2
Whale settlement channel
from_main_accountstringrequired

Source main account. Specifies Source main account. This field is required.

from_main_account_typestringrequired

Source main account type. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

from_account_idstringrequired

Source account id. Specifies Source account id. This field is required.

to_typestringrequired

Target party type.

Allowed values: 1 Bank, 2 Whale settlement channel

Values
1
Bank
2
Whale settlement channel
to_main_accountstringrequired

Target main account. Specifies Target main account. This field is required.

to_main_account_typestringrequired

Target main account type. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

to_account_idstringrequired

Target account id. Specifies Target account id. This field is required.

allocation_channelstringrequired

Allocation channel. Specifies Allocation channel. This field is required.

currencystringrequired

Currency. Specifies Currency. This field is required.

amountstringrequired

Amount. Specifies Amount. This field is required.

postscriptstringrequired

Postscript. Specifies Postscript. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

This is a write operation; on success it returns no business data, and data is always an empty object {}.

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs