Skip to content
Longport WhaleLongport Whale
Bank Account Management

Get User Bank Card List

Get User Bank Card List

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

Authorization

AuthorizationstringheaderRequired

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

Parameters

withdrawstringOptional

Is Withdraw Card 0,1

currencystringOptional

Currency (USD,HKD,SGD)

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

list

Child attributes
idnumber

User Bank Card Id. User Bank Card Id

regionstring

Region：mainland、hongkong、abroad. Region：mainland、hongkong、abroad

region_namestring

Region Name. Region Name

bankstring

Bank Name. Bank Name

bank_idinteger

bank_id

bank_enstring

Bank Name. Bank Name

accountstring

User Bank Account. User Bank Account

namestring

User Name. User Name

iconstring

Bank Icon. Bank Icon

swift_codestring

Bank Swift Code. Bank Swift Code

account_typestring

Account Type. Account Type

countrystring

Country. Country

addressstring

Address. Address

remarkstring

Remark. Remark

bank_codestring

Bank Code. Bank Code

logostring

Logo. Logo

left_backgroundstring

Lower left gradien. Lower left gradien

right_backgroundstring

Gradient to the upper right. Gradient to the upper right

witness_statenumber

Deposit Witness Status 1: No Witness Required, 2: Witness Pending, 3: Witnessed. Deposit Witness Status 1: No Witness Required, 2: Witness Pending, 3: Witnessed

support_witnessnumber

Whether the bank supports Witness. Whether the bank supports Witness

need_addressnumber

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

status number

Status0 Not verified 1 In review 2 Verified. Status0 Not verified 1 In review 2 Verified

name_enstring

User name. User name

need_swiftinteger

If need swift code. If need swift code

need_account_typeinteger

If need account type. If need account type

can_modify_card_accountboolean

Can nodify bank card account. Can nodify bank card account

auth_listarray<object>

auth_list

Child attributes
flow_idstring

Auth flow ID. Auth flow ID

statusinteger

State. State

namestring

Name. Name

messagestring

Error message. Error message

customstring

Different flow_id values return different parameters. When flow_id=4, FPSID is returned. When flow_id=3, a list of supported currencies is returned separated by commas. Different flow_id values return different parameters. When flow_id=4, FPSID is returned. When flow_id=3, a list of supported currencies is returned separated by commas

last_funding_currencystringrequired

Last deposit currency. Last deposit currency

last_funding_typeintegerrequired

Last deposit type. Last deposit type

last_bank_card_idintegerrequired

Last deposit card id. Last deposit card id

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