Skip to content
Longport WhaleLongport Whale
Assets

Get withdrawal pre-check information

Queries the withdrawable limits and withdrawal configuration for a given currency and bank card when the Client opens the withdrawal page. It returns the maximum withdrawable amount, the cash amount, the money-market fund amount, the per-currency breakdown, estimated arrival times, fee tiers by amount range, and the available payout methods, for the amount display, validation, and fee notices on the withdrawal form.

GEThttps://api.lbkrs.com/v4/portfolio/withdraw/pre

Parameters

currencystringqueryRequired

Withdrawal currency, such as HKD, USD, or CNH

card_idstringquery

Withdrawal bank card id, taken from the withdrawal bank card list operation. When omitted, only the amount information is returned, without the card-specific arrival times and fee tiers

account_channelstringquery

Tenant channel

from_app_pagestringquery

Payout scenario source, distinguishing a standard payout from a southbound or northbound payout; used only by some tenant channels

withdrawnorth_withdrawsouth_withdraw

sm3_codestringquery

Verification code; used only by some tenant channels

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get withdrawal pre-check information” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Per-currency breakdown of the withdrawable amount, used to show how the estimated maximum is composed

Child attributes
currencystring

Currency

amountstring

Withdrawable amount in that currency

cash_amountstring

Withdrawable cash amount; a withdrawal at or below this value follows the standard payout flow

max_amountstring

Maximum withdrawable amount (the estimated maximum shown to the Client), including the money-market fund portion; a withdrawal above this value is not allowed

mmf_amountstring

Withdrawable amount held in the money-market fund; a withdrawal between cash_amount and max_amount is paid out by redeeming it automatically

tip_timestring

Estimated arrival time in business days, such as "1-2"; an empty string when there is no bank card or no configuration

mmf_timestring

Estimated arrival time when the payout redeems the money-market fund, in business days, such as "2-3"; an empty string when there is no configuration

is_pad_fundedinteger

Money-market fund advance status, meaningful only when mmf_amount is greater than 0:

  • 1: no redemption needed; the platform advances the payout
  • 2: the money-market fund must be redeemed before the payout

12

currency_tipboolean

Whether a currency-related notice must be shown

need_payee_addressboolean

Whether the payee address must be provided

bank_operation_typearray<object>

Available payout methods; delivered only for some tenant channels

Child attributes
idstring

Payout method id

namestring

Payout method name

multi_namestring

Localized payout method name

directioninteger

Fund direction:

  • 0: both deposits and withdrawals
  • 1: withdrawal
  • 2: deposit

012

promptsarray<object>

Fee and arrival-time tiers by withdrawal amount range; Broker App matches the entered amount to a tier and shows the corresponding fee notice

Child attributes
min_amountstring

Lowest withdrawal amount this tier covers, which is also the minimum amount the Client can enter

max_amountstring

Highest withdrawal amount this tier covers

bank_feestring

Bank fee

plat_feestring

Platform fee

arrive_timestring

Estimated arrival time for this tier

mmf_timestring

Estimated arrival time for this tier when the payout redeems the money-market fund

fee_descriptionstring

Explanatory text for the bank fee

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs