WhaleAPI（Public）
  1. Cash And Stocks Transfer
WhaleAPI（Public）
  • Passthrough Headers
  • Generate signature
  • Account Trade Auth
    • Trade Password Auth（交易密码校验）
      POST
    • Trade Password Set（交易密码设置）
      POST
    • Trade Password Reset（交易密码修改/重置）
      POST
    • Account No. Login Password Auth 证券帐号登录密码校验
      POST
  • Accounts
    • Whale Record Agreement（同步签署协议状态）
    • Get Account Trade Permission（获取账户交易权限）
    • Update Account Trade Permission（更新账户权限）
    • Retrieve Account Application Information(获取证券账户开户资料信息)
    • Get Account List（获取用户账户列表）
    • Get Account Request List（获取用户开户申请列表）
    • Get Account Contact Info（获取账户联系方式）
    • Get Account Status（获取账户状态）
    • Get Account Bcan Information（获取账户 Bcan 信息）
    • Query Account List V2（获取账户列表V2）
    • Update Application（修改开户资料）
    • Update Account State/Disable Account（修改账户状态 / 冻结账户）
    • Submit Application V2（提交开户申请资料 V2）
    • Update Application V2（修改开户资料 V2）
    • Close Account（注销账户）
    • Open additional account(增开账户)
    • get account opening application information (开户申请信息获取)
    • Query Account Risk And Pi Info（获取用户风险测评以及Pi信息）
  • Asset
    • Query Total Holdings（查询全量股票持仓）
    • Query Account Cash Balance（账户现金查询）
    • Query Total Cash（查询全量现金）
    • Query Account Position（账户持仓查询）
    • Account Cash Balance Adjustment（账户资金调账）
    • Account Position Adjustment（账户持仓调账,只支持股票）
    • Account Cash Balance Freeze（账户资金冻结）
    • Account Cash Balance Unfreeze（账户资金解冻）
    • Account Cash Balance Unfreeze Debit（账户资金解冻扣款）
    • Account Stock Transaction History（账户股票流水）
    • Account Cash Transaction History（账户资金流水）
    • Account Stock Freeze Transaction History（账户股票冻结流水）
    • Account Cash Freeze Transaction History（账户资金冻结流水）
    • Query Limited Amount Information（限额信息查询）
    • Query Buy Power（购买力查询）
    • Query Short Sellable Quantity（可卖空数量查询）
    • Query OB Account Cash Balance（账户现金详情查询）【定制非通用】
    • Query Account Total Asset（账户资产查询）
    • Query account risk limit config（查询用户限额信息）
    • Query Account Total Asset OverView（账户资产总览）
    • Query HashKey Cash List（查询hashkey的现金列表）
    • Create account risk limit config（创建用户限额信息）
    • Update account risk limit config（更新用户限额信息）
    • Temp Adjust 临时调账新增
    • Temp Adjust Expire 临时调账手动失效
    • Get All Users Cash Balance (获取所有用户现金信息)
    • Temporary Adjustment（临时调账）
  • Billing
    • Fee estimate（费用预估）
  • Cash And Stocks Transfer
    • Add Bank Card
      POST
    • Delete Bank Card
      DELETE
    • Region Bank
      GET
    • Get User Bank Card List
      GET
    • User Card Detail
      GET
    • Deposit Detail
      GET
    • Submit Deposit Application
      POST
    • Deposit Application List
      GET
    • Update Bank Card
      PUT
    • Obtain the deposit information
      GET
    • Withdraw Records
      GET
    • Withdraw Detail
      GET
    • Cancel Withdraw Application
      POST
    • Get Exchange
      GET
    • Cancel Deposit
      POST
    • Submit Withdrawal Applylication
      POST
    • Information acquisition before withdrawal v3 （提现前信息获取V3）
      GET
    • Update Bank Card
      PUT
    • Submit Files For Review Withdraw Card
      POST
    • Currency List
      GET
    • Exchange records（兑换记录）
      GET
    • Stock transfer out detail (查看转出详情)
      GET
    • Stock transfer out records (查询转出记录)
      GET
    • Transfer in detail (查看转入详情)
      GET
    • Transfer in records (查询转入记录)
      GET
  • File
    • Get Tenant File Upload URL（获取租户文件上传链接）
  • IPO
    • Get Available IPO List(查詢可申购IPO列表)
    • Get IPO Detail Info（查詢IPO详情）
    • Get IPO Payable List（查詢申购股数单位等限制）
    • Get IPO Margin List（查詢IPO认购方式及费率方案）
    • Get Order List （查询IPO历史订单）
    • Submit New IPO Order（提交IPO申购）
    • Withdraw IPO Order（撤销IPO申请）
    • Amend IPO Order（修改IPO申购订单）
    • Get IPO Order Detail（获取IPO订单的详细信息）
    • Buy Limit (持仓打新购买力获取接口)
  • Member Core
    • Update PI Status
    • Change Member Mobile Phone（修改用户登录手机号）
    • Get Member Information by Mobile Phone（登录手机号查询用户信息）
    • Login (New user registration by default for the first login).（OpenId 注册登录接口，首次登录即注册）
    • Get Member Information by Login Email（登录邮箱查询用户信息）
    • Change Member Login Email（修改用户登录邮箱）
    • Logout By Session ID
  • Trade
    • Trade Websocket Notification
    • Historical Trade Detail Inquiry V2(历史成交明细查询V2)
    • Trade Detail Inquiry V3(成交明细查询V3)
    • Withdraw User Orders (批量撤销用户订单)
    • Historical Order Inquiry (历史订单查询)
    • Place Order (委托下单)
    • Modify Order (修改订单)
    • Withdraw Order (撤销订单)
    • Order Details (订单详情)
    • Today's Order Inquiry (当日订单查询)
    • Estimated Maximum Purchase Quantity (预估最大购买数量)
    • Today's Trade Detail Inquiry (当日成交明细查询)
    • Historical Trade Detail Inquiry (历史成交明细查询)
  • Message
    • Global Push Templates（全局推送模板）
    • Device Logout (设备登出解绑)
  • Search
    • Search Stock
  • Reward Center
    • 奖励中心- 发放奖励
    • 奖励中心 - 查询奖励状态
  • OpenAPI
    • Create Access Key
    • GetAccessKey
    • List Access Keys
    • Update Access Key
    • Disable Access Key
    • Enable Access Key
    • Renew Access Token
    • Revoke Access Token
  1. Cash And Stocks Transfer

Information acquisition before withdrawal v3 （提现前信息获取V3）

GET
/v1/whaleapi/portfolio/withdraw/pre
Cash And Stocks Transfer
Information acquisition before withdrawal v3 （提现前信息获取V3）

Request

Authorization
Query Params
currency
string 
required
Currency
Example:
USD
card_id
integer <int32>
optional
User Bank Card Id（The current card ID can be passed blank. After passing blank, tip_time will not be obtained）
Example:
112
account_no
string 
required
Account No

Responses

🟢200OK
*/*
success
Body
cash_amount
string 
required
Cash Amount(cash portion)
max_amount
string 
required
Max Amount（The total amount that can be withdrawn (including Balance Pass)）
mmf_amount
string 
required
Mmf Amount(If a Balance Pass is used, the corresponding amount in that currency)
is_pad_funded
string 
required
Is Pad-fundedoption values:[1 cushion, no need to redeem (this type is also returned in the case of pure CASH) 2 No cushion, to go through the redemption process]
cash_list
array [object {2}] 
required
Amount Info List
currency
string 
optional
Currency
amount
string 
optional
Amount
tip_time
string 
required
Estimated time of receipt
mmf_time
string 
required
Estimated time of when use Mmf
currency_tip
boolean 
required
Whether a withdraw prompt
Example
{
  "cash_amount": "string",
  "max_amount": "string",
  "mmf_amount": "string",
  "is_pad_funded": "string",
  "cash_list": [
    {
      "currency": "string",
      "amount": "string"
    }
  ],
  "tip_time": "string",
  "mmf_time": "string",
  "currency_tip": true
}
Modified at 2026-04-09 08:59:44
Previous
Submit Withdrawal Applylication
Next
Update Bank Card