Settle Chnl Acct · Whale Docs

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

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

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.

bank_idstring

Filters results by Bank Name.

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

bank_accountstring

Filters results by Bank Account.

settlement_channelstring

Filters results by Settle Channel.

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

idstring

Filters results by ID.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Settle Chnl Acct 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.

settlement_channelstring

Returned value: Settle Channel.

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.

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.

account_namestring

Returned value: Account Name.

multi_namestring

Returned value: Bank Name.

bank_accountstring

Returned value: Bank Account.

regionstring

Returned value: Country Region.

swift_codestring

Returned value: Swift Code.

bank_addrstring

Returned value: Bank Address.

withdraw_typesstring

Returned value: Withdrawal Channel.

withdraw_types_valstring

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

remarkstring

Returned value: Remark.

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.

created_atstring

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

updated_atstring

Returned value: 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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/account_settlement_accounts' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "1174",
        "settlement_channel": "settlement_hashkey_hk",
        "currency_type": "Fiat",
        "currency_type_val": "fiat",
        "currency": "ALL",
        "currency_val": "ALL",
        "account_name": "法币1",
        "multi_name": "041 Chong Hing Bank Limited",
        "bank_account": "示例用户",
        "region": "Hong Kong",
        "swift_code": "LCHBHKHH",
        "bank_addr": "示例地址 Example Address",
        "withdraw_types": "Account Withdrawal,Account Transfer",
        "withdraw_types_val": "VA_WITHDRAW,VA_TRANSFER",
        "remark": "",
        "updated_admin_id": "术士 (Li Yang)",
        "updated_admin_id_val": "21408",
        "created_at": "1780898477",
        "updated_at": "1780898477"
      }
    ],
    "total": 6
  }
}