Skip to content
Company Fund Allocation

Company Fund Allocation

Queries Company Fund Allocation data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

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_transfers

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

Authorizationstringheaderatm.company_fund_allocation_inquiryRequired

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

Query parameters

filtersobject

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

Child attributes
idstring

ID. Filters results by ID.

channel_serial_nostring

Chnl Ref No.. Filters results by Chnl Ref No..

transfer_typestring

Allocation Type. Filters results by Allocation Type.

Allowed values:

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

1234

statusstring

Status. Filters results by Status.

Allowed values:

  • 1,3 - In Channel Processing
  • 2 - Pending Approval
  • 4 - Success
  • 5 - Failed
  • 6 - Abnormal
  • 7 - Rejected

1,324567

currency_typestring

Currency Type. Filters results by Currency Type.

Allowed values:

  • fiat - Fiat
  • crypto - Crypto

fiatcrypto

currencystring

Currency. Filters results by Currency.

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

amountobject

Amount Range. Filters results by Amount Range.

Child attributes
gtenumber

Greater Than or Equal. Inclusive lower bound of the filter range.

ltenumber

Less Than or Equal. Inclusive upper bound of the filter range.

created_atobject

Created Time. Filters results by Created Time.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

updated_atobject

Updated Time. Filters results by Updated Time.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

order_idstring

Order ID. Filters results by Order ID.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

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

List. Returned value: List of list.

Child attributes
idstring

ID. Returned value: Unique identifier of the current record.

transfer_typestring

Allocation Type. Returned value: Allocation Type.

transfer_type_valstring

Allocation Type (raw value). 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.

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). 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.

from_typestring

Payment Account Info - Payment Channel. Returned value: Payment Account Info - Payment Channel.

from_type_valstring

Payment Account Info - Payment Channel (raw value). 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

Payment Account Info - Main Account. Returned value: Payment Account Info - Main Account.

from_main_account_typestring

Payment Account Info - Main Account Type. Returned value: Payment Account Info - Main Account Type.

from_bank_namestring

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

from_account_namestring

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

from_accountstring

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

custom_fromstring

Payment Account Info. Returned value: Payment Account Info.

fee_bank_namestring

Handling fee account info - Bank Name. Returned value: Handling fee account info - Bank Name.

fee_bank_accountstring

Handling fee account info - Bank Account No.. Returned value: Handling fee account info - Bank Account No..

fee_simple_namestring

Handling fee account info - Abbreviation. Returned value: Handling fee account info - Abbreviation.

fee_swift_codestring

Handling fee account info - Swift Code. Returned value: Handling fee account info - Swift Code.

from_charge_typestring

Handling fee account info - Bank Cost Paid By. Returned value: Handling fee account info - Bank Cost Paid By.

custom_from_feestring

Handling fee account info. Returned value: Handling fee account info.

allocation_channel_valstring

Allocation Channel. Returned value: Allocation Channel.

to_typestring

Receiving Account Info - Deposit Channel. Returned value: Receiving Account Info - Deposit Channel.

to_type_valstring

Receiving Account Info - Deposit Channel (raw value). 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

Receiving Account Info - Main Account. Returned value: Receiving Account Info - Main Account.

to_main_account_typestring

Receiving Account Info - Main Account Type. Returned value: Receiving Account Info - Main Account Type.

to_bank_namestring

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

to_account_namestring

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

to_accountstring

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

custom_tostring

Receiving Account Info. Returned value: Receiving Account Info.

currency_typestring

Currency Type. Returned value: Currency Type.

currency_type_valstring

Currency Type (raw value). 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

Currency. Returned value: Currency.

amountstring

Amount. Returned value: Amount.

custom_amountstring

Amount (Currency). Returned value: Amount (Currency).

postscriptstring

Transfer Memo. Returned value: Transfer Memo.

exceptionstring

Exception Return. Returned value: Exception Return.

rule_idstring

Allocation Configuration. Returned value: Allocation Configuration.

order_idstring

Order ID. Returned value: Order ID.

custom_remarkstring

Remarks. Returned value: Remarks.

channel_serial_nostring

Chnl Ref No.. Returned value: Chnl Ref No..

ticket_admin_idstring

Operator - Initiator. Returned value: Operator - Initiator.

ticket_admin_id_valstring

Operator - Initiator (raw value). Raw value of ticket_admin_id. The ticket_admin_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

exception_admin_idstring

Operator - Abnormal Operator. Returned value: Operator - Abnormal Operator.

exception_admin_id_valstring

Operator - Abnormal Operator (raw value). Raw value of exception_admin_id. The exception_admin_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_adminstring

Operator. Returned value: Operator.

custom_admin_valstring

Operator (raw value). Raw value of custom_admin. The custom_admin field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_timestring

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

created_atstring

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

account_atstring

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

updated_atstring

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

totalintegerrequired

Total. 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