Skip to content
Withdrawals

Submit Withdrawal Request

Submits a withdrawal request with the selected currency, amount, and receiving bank card, and returns the withdrawal request id once accepted. ok set to true means only that the request was accepted; whether the funds are remitted is determined by the withdrawal record status.

Preconditions: a usable card has been selected through GET /v3/portfolio/withdraw/cards, and “Get withdrawal pre-check information” (GET /v4/portfolio/withdraw/pre or GET /v4/portfolio/withdraw/pre) has confirmed that the amount does not exceed max_amount and is not below the currency’s minimum withdrawal amount. If the card requires a payee address, save it first with POST /v1/portfolio/withdraw/card/address.

Side effects: creates a withdrawal request. On success, use the returned id to call GET /v7/portfolio/withdraw/detail, and find the request in GET /v6/portfolio/withdraw/record. While the status is 0 or 15, it can be cancelled with POST /v2/portfolio/withdraw/cancel. On failure, handle the business code; for other codes, show message to the Client instead of resubmitting immediately.

When calling through WhaleCore requestService(), set requiresTradeToken to true.

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.

POSThttps://api.lbkrs.com/v5/portfolio/withdraw

Request body application/json

currencystringrequired

Withdrawal currency, for example HKD

amountstringrequired

Withdrawal amount as a decimal string; must be greater than 0 and not exceed max_amount from the pre-check

card_idstringrequired

Receiving bank card id from list[].id of “Get Withdrawal Bank Cards”

bank_card_identitystring

Receiving bank card identity from list[].bank_card_identity of “Get Withdrawal Bank Cards”

account_channelstringrequired

Broker channel

is_pad_fundedstringrequired

MMF advance mode, with the same meaning as is_pad_funded in the pre-check:

  • 1 - No redemption; the platform advances the funds
  • 2 - Redeem the MMF before withdrawing

The Broker App currently always passes 2.

Values
1
2
bank_operation_type_idstring

Payout method id from bank_operation_type[].id in the pre-check; pass null or omit it when no payout method is offered

confirminteger

Reward forfeiture confirmation. When this withdrawal disqualifies the Client from a reward-lock campaign or incurs a fee, show the affected rewards (GET /rewards/lock_activities) to the Client, obtain consent, and resubmit with 1; omit it otherwise

Values
1

Responses

HTTP 200The request succeeded. The response body contains the result of the “Submit Withdrawal Request” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean

Whether the request was accepted

idstring

Withdrawal request id, used to query the withdrawal details and to change the receiving bank card

tip_timestring

Estimated arrival time in business days, for example 1-2; shown on the withdrawal result page

disable_linkboolean

Whether to hide the withdrawal details entry. When true, the result page does not link to the details

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