Skip to content
Funds Alloc Config

Funds Alloc Config

Queries Funds Alloc Config data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/account_fund_transfer_rules

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
idstring

Filters results by ID.

currency_typestring

Filters results by Currency Type.

Allowed values:

  • fiat - Fiat
  • crypto - Crypto

fiat · Fiatcrypto · Crypto

currencystring

Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/company_account_types to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

transfer_typestring

Filters results by Allocation Type.

Allowed values:

  • 1 - Interbank transfer
  • 2 - Settlement account recharge
  • 3 - Settlement account withdrawal
  • 4 - Inter-settlement account transfer

1 · Interbank transfer2 · Settlement account recharge3 · Settlement account withdrawal4 · Inter-settlement account transfer

statusstring

Filters results by Status.

Allowed values:

  • 1 - Enabled
  • 2 - Disabled

1 · Enabled2 · Disabled

created_atobject

Filters results by Created Time.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

updated_atobject

Filters results by Updated Time.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Funds Alloc Config records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

transfer_typestring

Returned value: Allocation Type.

transfer_type_valstring

Raw value of transfer_type. The transfer_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

from_typestring

Returned value: Payment Account Info - Payment Channel.

from_type_valstring

Raw value of from_type. The from_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

from_main_accountstring

Returned value: Payment Account Info - Main Account.

from_main_account_typestring

Returned value: Payment Account Info - Main Account Type.

from_bank_namestring

Returned value: Payment Account Info - Bank Name.

from_account_namestring

Returned value: Payment Account Info - Bank Account Name.

from_accountstring

Returned value: Payment Account Info - Bank Account No..

custom_fromstring

Returned value: Payment Account Info.

allocation_channel_valstring

Returned value: Allocation Channel.

transfer_strategystring

Returned value: Allocation Strategy.

transfer_strategy_valstring

Raw value of transfer_strategy. The transfer_strategy field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_package_typestring

Returned value: Frequency.

to_typestring

Returned value: Receiving Account Info - Deposit Channel.

to_type_valstring

Raw value of to_type. The to_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_main_accountstring

Returned value: Receiving Account Info - Main Account.

to_main_account_typestring

Returned value: Receiving Account Info - Main Account Type.

to_bank_namestring

Returned value: Receiving Account Info - Bank Name.

to_account_namestring

Returned value: Receiving Account Info - Bank Account Name.

to_accountstring

Returned value: Receiving Account Info - Bank Account No..

custom_tostring

Returned value: Receiving Account Info.

currency_typestring

Returned value: Currency Type.

currency_type_valstring

Raw value of currency_type. The currency_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Returned value: Currency to Alloc.

currency_valstring

Raw value of currency. The currency field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

amount_showstring

Returned value: Amt to Alloc.

amount_show_valstring

Raw value of amount_show. The amount_show field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

postscriptstring

Returned value: Transfer Memo.

statusstring

Returned value: Status.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

prioritystring

Returned value: Priority.

updated_admin_idstring

Returned value: Updater.

updated_admin_id_valstring

Raw value of updated_admin_id. The updated_admin_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_timestring

Returned value: Time. The date or time format follows the value returned by the API.

created_atstring

Returned value: Time - Create Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Time - Update Time. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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