Skip to content
Withdrawals

Information acquisition before withdrawal v3

Information acquisition before withdrawal v3

GEThttps://b-api.longbridge.xyz/v2/whaleapi/portfolio/withdraw/pre

Authorization

AuthorizationstringheaderRequired

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

Parameters

currencystringRequired

Currency

card_idintegerOptional

User Bank Card Id(The current card ID can be passed blank. After passing blank, tip_time will not be obtained)

account_nostringRequired

Account No

Responses

HTTP 200Fields are taken from the real responses definition for this operation in the published Whale OpenAPI spec (whale-openapi/Whale-openapi.json).
cash_amountstring

Cash Amount(cash portion). Cash Amount(cash portion)

max_amountstring

Max Amount(The total amount that can be withdrawn (including Balance Pass)). Max Amount(The total amount that can be withdrawn (including Balance Pass))

mmf_amountstring

Mmf Amount(If a Balance Pass is used, the corresponding amount in that currency). Mmf Amount(If a Balance Pass is used, the corresponding amount in that currency)

is_pad_fundedstring

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]. 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_listarray<object>

Amount Info List. Amount Info List

Child attributes
currencystring

Currency. Currency

amountstring

Amount. Amount

tip_timestring

Estimated time of receipt. Estimated time of receipt

mmf_timestring

Estimated time of when use Mmf. Estimated time of when use Mmf

currency_tipboolean

Whether a withdraw prompt. Whether a withdraw prompt

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