Skip to main content

Request a withdrawal to an external wallet or separate BitMEX account.

POST 
/api/v1/user/requestWithdrawal

Email Confirmation​

In most cases, this endpoint will send a confirmation email to the email address on record. When withdrawing to a saved address (i.e. given addressId or a corresponding address) with skipConfirm configured, the withdrawal will be immediately confirmed.

Two-Factor Authentication​

A valid 2FA code (otpToken) is required for all withdrawals unless the destination address is associated with either a saved address with skip2FA configured or a linked BitMEX account (e.g. a subaccount).

Internal Transfers​

If a valid BitMEX deposit address is provided, the transaction will be made directly between BitMEX accounts. There will be no resulting on-chain transaction and no network fee will be charged.

When given another account ID (targetUserId), the request will only succeed if the account is linked to the authenticated account.

Note that /api/v1/user/walletTransfer may be a more suitable endpoint for transfers between linked accounts.

Saved Address Verification​

Please note that when using saved addresses, skip2FA and skipConfirm require verification:

  • skip2FA can be verified by providing otpToken when creating the address. If otpToken is not provided, a 2FA code can be provided by visiting the link included in the email sent upon address creation.

  • skipConfirm can be verified by visiting the link included in the email sent upon address creation.

Whitelist​

If the address book has the whitelist setting enabled, all withdrawal requests must be directed to either a saved addresses or a linked account. All other addresses will be rejected. Note that saved addresses must be active. A new saved address is active if it has been 2FA verified and a cooldown period has passed since its creation.

Request​

Responses​

Request was successful