Skip to content
Longport WhaleLongport Whale
Bank Account Management

Region Bank

Region Bank

GEThttps://b-api.longbridge.xyz/v1/whaleapi/portfolio/withdraw/banks

Authorization

AuthorizationstringheaderRequired

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

Parameters

currencystringRequired

Currency（Currency. If not provided, it will default to HKD. This parameter is mainly used for obtaining corresponding tags for banking, securities, eDDA, and FPS payments for a particular currency. In Hong Kong, bank lists are sorted by tag count and tag priority. The currency only affects the sorting of the bank list in the Hong Kong region）

account_nostringRequired

Account No

Responses

HTTP 200Fields are taken from the real responses definition for this operation in the published Whale OpenAPI spec (whale-openapi/Whale-openapi.json).
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Bank List. Bank List

Child attributes
valuearray<object>

value

Child attributes
idnumber

ID. ID

namestring

Bank name. Bank name

name_enstring

English bank name. English bank name

swift_codestring

Swift code. Swift code

iconstring

Bank icon url. Bank icon url

logostring

Bank logo url. Bank logo url

left_backgroundstring

Bottom-left gradient color. Bottom-left gradient color

right_backgroundstring

Top-right gradient color. Top-right gradient color

bank_codestring

Bank Code. Bank Code

support_witnessstring

support deposit witness 0:not support 1:support. support deposit witness 0:not support 1:support

account_lengthstring

Maximum length limit of bank card. Maximum length limit of bank card

auth_flowsarray<object>

Support auth list. Support auth list

Child attributes
HKDobject

currency HKD. currency HKD

Child attributes
Idsarray<string>required

authFlowId. authFlowId

USDobject

Currency USD. Currency USD

regionstring

Region. Region

region_namestring

Region name. Region name

bankcode_statenumber

bankcode state, 0: optional |1: required. bankcode state, 0: optional |1: required

need_addressinteger

need address 0:no need 1:required. need address 0:no need 1:required

required_addressinteger

Is the address a required field 0:no need 1:required. Is the address a required field 0:no need 1:required

need_swiftinteger

if the swift code is required:0:no need 1:required. if the swift code is required:0:no need 1:required

need_account_typeinteger

if the account type is required:0:no need 1:required. if the account type is required:0:no need 1:required

iconstring

icon url. icon url

tipstring

tip. tip

tagsstring

tags. tags

mainland_card_flagstringrequired

Whether the mainland bank card is bound. Whether the mainland bank card is bound

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