Company Bank Account · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_withdraw_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

nature_typestring

Filters results by Account Type.

Allowed values:

client - Client
house - House

client · Clienthouse · House

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_namestring

Filters results by Bank Name.

bank_accountstring

Filters results by Bank Account.

support_exchangestring

Filters results by Exchange Supported?.

Allowed values:

0 - Not Supported
1 - Support

0 · Not Supported1 · Support

simple_namestring

Filters results by Abbreviation.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Company Bank Account 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.

nature_typestring

Returned value: Account Nature.

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.

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

bank_codestring

Returned value: ABA routing number.

provincestring

Returned value: Province.

citystring

Returned value: City.

postal_codestring

Returned value: Postal Code.

simple_namestring

Returned value: Abbreviation.

custom_instring

Returned value: Deposit Channel.

custom_outstring

Returned value: Withdrawal Channel.

support_exchangestring

Returned value: Exchange Supported?.

support_exchange_valstring

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

updated_atstring

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

created_atstring

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

remarkstring

Returned value: Remark.

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/atm_withdraw_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": "1866",
        "nature_type": "client",
        "currency": "ALL",
        "currency_val": "ALL",
        "account_name": "test",
        "bank_name": "DBS Bank",
        "bank_account": "示例用户",
        "region": "SINGAPORE",
        "swift_code": "DBSSSGSG",
        "bank_addr": "示例地址 Example Address",
        "bank_code": "",
        "province": "",
        "city": "",
        "postal_code": "",
        "simple_name": "11",
        "custom_in": "",
        "custom_out": "",
        "support_exchange": "Not Supported",
        "support_exchange_val": "0",
        "updated_at": "1784171302",
        "created_at": "1784171302",
        "remark": ""
      }
    ],
    "total": 122
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_withdraw_accounts/download

Export options Export records Download result