v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB

Withdraw

Create withdraw request

The endpoint creates withdraw for the specified ticker.

<Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note> <Note> Also, fiat currencies can't be withdrawn without KYC verification. </Note>

post/api/v4/main-account/withdraw

Request body

tickerstring required

Currency's ticker. Example: BTC

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

amountstring required

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

addressstring required

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

memostring

Memo.

⚠️ Required if currency is memoable.

uniqueIdstring required

Unique transaction identifier. Any string up to 255 characters; not validated as a UUID.

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

providerstring

Fiat currency provider. Example: VISAMASTER

⚠️ Required for fiat currencies. Currency provider should be taken from Asset Status endpoint response.

networkstring

Cryptocurrency network. Available for multi network currencies. Example: OMNI

⚠️ Currency network should be taken from Asset Status endpoint response. Default for USDT is ERC20

partialEnableboolean

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.

customerIpstring

End-customer IP address forwarded to the fiat provider for antifraud checks before the withdrawal is processed.

⚠️ Required if currency ticker is USD or EUR with VISAMASTER provider.

paymentDescriptionstring

Description of withdrawal destination

⚠️ Required if currency is crypto and withdrawal from whitebit-tr.com

requeststring required

Request signature

nonceinteger required

Unique request identifier

Example request

{
  "ticker": "ETH",
  "amount": "0.9",
  "address": "0x0964A6B8F794A4B8d61b62652dB27ddC9844FB4c",
  "memo": "48565488244493",
  "uniqueId": "24529041",
  "provider": "VISAMASTER",
  "network": "ERC20",
  "customerIp": "203.0.113.42",
  "beneficiary": {
    "firstName": "Firstname",
    "lastName": "Lastname",
    "tin": 1000000000,
    "phone": "1234567891",
    "email": "john_doe@email.com",
    "birthDate": "1990-01-01",
    "code": "123456",
    "cardToken": "tok_4f7c8e2a",
    "fingerprintSession": "fps_abc123",
    "card": {
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "number": "4111111111111111",
      "month": "12",
      "year": "2030"
    },
    "address": {
      "line1": "Martinez Campos 37",
      "city": "Madrid",
      "zip": "28010",
      "country": "ES"
    },
    "bank": {
      "routingNumber": "021000021",
      "name": "Example Bank",
      "address": "1 Bank Street, London",
      "country": "GB"
    }
  },
  "travelRule": {
    "walletType": "hosted",
    "beneficiary": {
      "type": "individual",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "Acme Trading Ltd",
      "residenceCountry": "DEU",
      "address": {
        "country": "DEU",
        "city": "Berlin",
        "postCode": "10178",
        "addressLine1": "Alexanderplatz 1"
      }
    },
    "vaspData": {
      "vaspId": "vasp-001",
      "vaspName": "Famous Vasp Inc"
    }
  },
  "paymentDescription": "Payment description",
  "request": "{{request}}",
  "nonce": 1594297865000
}

Response

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

{"stackTrail":"paths:/api/v4/main-account/withdraw:post:responses:201:content:application/json:schema:items","oasType":"schema","type":"unknown"}