Skip to content
Withdrawals

Get Withdrawal Bank Cards

Queries the bank cards the Client has bound, together with the bank card and currency used for the last withdrawal. Used on the withdrawal page to select the receiving bank card and to set the default card and currency.

This is the first step of the withdrawal flow. After selecting a card, call “Get withdrawal pre-check information” (GET /v4/portfolio/withdraw/pre; some tenant channels use GET /v4/portfolio/withdraw/pre) for the withdrawable amount and fees, then call POST /v5/portfolio/withdraw to submit the withdrawal. Only cards whose bind_state is 1 (or absent), whose status is not 1, and whose account_type matches the withdrawal currency can be used. When changing the receiving card of a withdrawal request, also pick the new card from this list.

With withdraw=0, it returns all bound bank cards; the endpoint is also used by the bank card management page and for selecting bank cards in ACH and wire deposits and withdrawals.

A complete withdrawal flow runs in this order: get the withdrawal bank cards (GET /v3/portfolio/withdraw/cards) → get the withdrawal pre-check information and withdrawable amount (GET /v4/portfolio/withdraw/pre; some tenant channels use GET /v4/portfolio/withdraw/pre; to get only the withdrawable balance by currency, call GET /v1/rms_gateway/get_account_all_single_currency_withdraw) → check and add the payee address when required → submit the withdrawal request (POST /v5/portfolio/withdraw) → query withdrawal records and details → cancel the withdrawal or change the receiving bank card when needed.

GEThttps://api.lbkrs.com/v3/portfolio/withdraw/cards

Parameters

withdrawstringqueryRequired

Usage scenario:

  • 1 - Select a card on the withdrawal page
  • 0 - Return all bound bank cards (bank card management, ACH and wire deposits and withdrawals)

01

filterstringqueryRequired

Filter flag. The Broker App currently always passes 0

from_app_pagestringquery

Withdrawal scenario source, used to distinguish regular withdrawals from southbound and northbound withdrawals; used only by some tenant channels

withdrawnorth_withdrawsouth_withdraw

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Withdrawal Bank Cards” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
last_bank_card_idstring

Id of the bank card used for the last withdrawal. When it is 0 or not among the usable cards, the Broker App selects the first usable card by default

last_funding_currencystring

Currency used for the last withdrawal. When empty, the Broker App recommends a default currency from the first card’s account_type

listarray<object>

Bound bank cards

Child attributes
idstring

Bank card id, used as card_id for the pre-check and the withdrawal request

bank_card_identitystring

Bank card identity. Together with id, it identifies one bank card; pass it with card_id when submitting a withdrawal request

bankstring

Bank name

bank_enstring

Bank name in English

bank_codestring

Bank code; FPS indicates a Faster Payment System (FPS) receiving account

accountstring

Bank account number

account_typestring

Currency the card supports for withdrawals, for example HKD; ALL means all currencies. The withdrawal currency must match this value unless it is ALL

regionstring

Full name of the region where the bank card is issued, for example HONGKONG

swift_codestring

Bank SWIFT code

iconstring

Bank icon URL

statusinteger

Bank card verification status:

  • 0 - Not verified; the card must be verified first
  • 1 - Under verification review; withdrawals cannot be submitted
  • 2 - Verified
Values
0
1
2
witness_stateinteger

Deposit witness status:

  • 1 - No witness required
  • 2 - Witness pending
  • 3 - Witnessed

For accounts opened with cash verification, only cards in status 1 or 3 can be used for withdrawals.

Values
1
2
3
bind_stateinteger

Binding status:

  • 0 - Binding under review
  • 1 - Bound
  • 2 - Binding failed

Treat a missing value as bound. Only bound cards can be used for withdrawals.

Values
0
1
2
Whale Docs