Skip to content
Longport WhaleLongport Whale
Withdrawals

Submit Withdrawal Application

Submits a withdrawal application for the given securities account.

Request parameters

  • Required: account_no, currency, amount, card_id, is_pad_funded
  • Optional: confirm, external_order_no

Business notes

  • card_id must be a certified (status=2) withdrawal card of this account.

Common errors

  • 2031034: the card is not certified (Please authenticate the current card first).
  • 2031199: the card's structured payee address is incomplete (payee structured address incomplete).
  • 2036001: the card does not exist or does not belong to this account (withdraw card not found).
POSThttps://b-api.lbkrs.com/v2/whaleapi/portfolio/withdraw

Authorization

AuthorizationstringheaderRequired

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

Permission

cmbc.user_withdraw_application

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

currencystringrequired

Currency

amountstringrequired

Amount

card_idintegerrequired

User bank card ID. Must be a certified (status=2) withdrawal card of this account.

confirminteger

Risk control parameters

is_pad_fundedintegerrequired

Whether pre-funded.

Allowed values: 1 Pre-funded, no fund redemption needed (also returned for cash-only cases), 2 Not pre-funded, fund redemption needed

Values
1
Pre-funded, no fund redemption needed (also returned for cash-only cases)
2
Not pre-funded, fund redemption needed
account_nostringrequired

Account No

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

external_order_nostring

External Order No

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean

Is submit success\

tip_urlstring

Risk control URL

idstringrequired

Order 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