Create Withdrawal

This end point initiates the withdrawal of an authenticated account.

PATH PARAMS

user_id - string
The User ID. Use 'me' if you are creating withdrawal from the master account, use the user_id if creating withdrawal from the Sub-account linked to the authenticated user.

BODY PARAMS

currency - string
Currency. Allowed valued: Required. Allowed values: Currencies - qdx, usd, ngn, ghs, btc, usdt, busd, cfx, usdc, cnhc, eth, bnb, xrp, ltc, wkd, bch, doge, dash, trx, one, link, cake, xlm, axs, shib, afen, bls, fil, ada, dot, babydoge, xtz, matic, sfm, aave, wsg, ckt, floki, sol, mana, ftm, sand, slp, enj, lrc, ape, sushi, zil.

amount - string
value to be sent to the recipient.

fund_uid - string
this can be the id of your sub user, or crypto address.

transaction_note - string
notes for the recipient

narration - string
narration for the recipient

fund_uid2 - string
destination tag

network - string
Optional: Blockchain network for the transaction, here is to the supported blockchain page: https://docs.quidax.com/docs/supported-cryptocurrencies

Sample Request

curl --request POST \
     --url https://www.quidax.com/api/v1/users/<user_id>/withdraws \
     --header 'Authorization: Bearer s3cr3tk3y' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "currency": "btc",
  "amount": "0.0000004",
  "transaction_note": "Stay safe",
  "narration": "We love you.",
  "fund_uid": <wallet address or sub account>
}
'
const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    Authorization: 'Bearer s3cr3tk3y'
  },
  body: JSON.stringify({
    currency: 'btc',
    amount: '0.0000004',
    transaction_note: 'Stay safe',
    narration: 'We love you.'
  })
};

fetch('https://www.quidax.com/api/v1/users/me/withdraws', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Sample Response

{
  "status": "success",
  "message": "Successful",
  "data": {
    "id": "f7ud47rz",
    "reference": null,
    "type": "coin_address",
    "currency": "trx",
    "amount": "1.0",
    "fee": "1.0",
    "total": "2.0",
    "txid": null,
    "transaction_note": "love you",
    "narration": "smile more",
    "status": "Processing",
    "reason": null,
    "created_at": "2021-11-24T14:47:11.000Z",
    "done_at": null,
    "recipient": {
      "type": "coin_address",
      "details": {
        "address": "TWMjBKD61DLXXQr6AvVnDMcVs5p46QSFzT",
        "destination_tag": null,
        "name": null
      }
    },
    "wallet": {
      "id": "j5lzsrz7",
      "currency": "trx",
      "balance": "0.0000020029",
      "locked": "2.0",
      "staked": "0.0",
      "converted_balance": "0.00011356443",
      "reference_currency": "ngn",
      "is_crypto": true,
      "created_at": "2021-04-09T09:48:14.000Z",
      "updated_at": "2021-11-24T14:47:11.000Z",
      "deposit_address": "TZCDWPRaoMay6GSJpbv6yEk2Nn7nE11XwX",
      "destination_tag": null
    },
    "user": {
      "id": "23azi7bj",
      "sn": "QDXXIRPXXKS",
      "email": "[email protected]",
      "reference": null,
      "first_name": "Oye",
      "last_name": "Olalekan",
      "display_name": "appstate",
      "created_at": "2021-04-09T09:48:14.000Z",
      "updated_at": "2021-04-09T10:54:32.000Z"
    }
  }
}
{
  "status": "error",
  "message": "Invalid secret key.",
  "data": {
    "code": "E0001",
    "message": "Invalid secret key."
  }
}