Skip to main content
POST
/
api
/
v4
/
main-account
/
withdraw-pay
Create withdraw request with specific withdraw amount (fee not included)
curl --request POST \
  --url https://whitebit.com/api/v4/main-account/withdraw-pay \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "ticker": "<string>",
  "amount": "<string>",
  "address": "<string>",
  "uniqueId": "<string>",
  "request": "<string>",
  "nonce": "<string>",
  "memo": "<string>",
  "provider": "<string>",
  "network": "<string>",
  "partialEnable": true,
  "beneficiary": {},
  "travelRule": {}
}
'
[]
Example:
  • When creating a base withdraw with amount = 100 USD, the receiver receives 100 USD minus the fee, and the balance decreases by 100 USD.
  • When calling the endpoint with amount = 100 USD, the receiver receives 100 USD, and the balance decreases by 100 USD + fee amount.

Authorizations

​
X-TXC-APIKEY
string
header
required

API key authentication using signed requests

Body

application/json
​
ticker
string
required

Currencies ticker. Example: BTC ⚠️ Currencies ticker must have "can_deposit" status equal to "true". Use Asset Status endpoint to know more about currency.

​
amount
string
required

Withdraw amount (including fee). To add the fee to the specified amount, use the /main-account/withdraw-pay request

​
address
string
required

Target address (wallet address for cryptocurrencies, identifier/card token for fiat currencies)

​
uniqueId
string
required

Unique transaction identifier. ⚠️ Generate a new unique ID for each withdrawal request.

​
request
string
required

Request signature

​
nonce
string
required

Unique request identifier

​
memo
string

Required if currency is memoable. See memo for details.

​
provider
string

Fiat currency provider. Example: VISAMASTER ⚠️ Currency provider should be taken from Asset Status endpoint response. Required if currency is fiat.

​
network
string

Cryptocurrency network. Available for multinetwork currencies. Example: OMNI ⚠️ Currency network should be taken from Asset Status endpoint response. Default for USDT is ERC20

​
partialEnable
boolean

Optional parameter for FIAT withdrawals with increased Maximum Limit if set as "true". To use this parameter, the application must support "Partially successful" withdrawal status and latest updates in deposit/withdrawal history.

​
beneficiary
object

Beneficiary information data. Required if currency ticker is one of: UAH_IBAN, USD_VISAMASTER, EUR_VISAMASTER, USD, EUR

​
travelRule
object

Travel Rule information data. Required if currency is crypto and the account is from EEA

Response

Validation succeeded and withdraw creation process is started. Check the request status by uniqueId in deposit/withdraw history.