Create Withdraw

POST api/v3/liquidity/withdraws

Creates new withdrawal request.

Parameters

Name	Type	Mandatory	Description
currency	STRING	YES	Currency code (e.g., btc, eth).
blockchain_key	STRING	YES	Blockchain network key (e.g., eth-mainnet).
amount	STRING	YES	Amount to withdraw.
rid	STRING	YES	Recipient ID or wallet address.
totp	STRING	YES	Time-based one-time password (TOTP) for verification.
note	STRING	NO	Optional note or memo for the transaction. Maximum size: 256.
include_fee	BOOLEAN	NO	Whether to include the fee in the amount. (default: true)

Request Body

{
  "currency": "bnb",
  "blockchain_key": "bsc-testnet",
  "amount": 0.05,
  "rid": "0x17fe22f2e7e95d28cec73b3815f0020cff41f7b5",
  "totp": "398142",
  "note": "Transfer User"
}

Responses

• 200 Successful response

Returns a withdrawal object with details about the created withdrawal request. The response can be either an external withdrawal (to a blockchain address) or an internal withdrawal (to another platform user).

Response Fields:

• id: Unique withdrawal request identifier
• currency_id: Currency code
• type: Asset type (coin, fiat)
• blockchain_key: Blockchain network identifier
• total: Total withdrawal amount
• amount: Amount after deducting fees
• fee: Transaction fee amount
• blockchain_txid: Blockchain transaction ID (populated when withdrawal succeeds on blockchain)
• rid: Recipient ID or wallet address
• state: Withdrawal state. Possible values: prepared (initial), canceled, accepted, skipped, to_reject, rejected, processing, under_review, succeed, deposited, failed, errored, confirming, locked
• internal_type: Type of internal transfer (address, platform_transfer, etc.) or null for external
• confirmations: Number of blockchain confirmations
• error_message: Error details if withdrawal failed
• transaction_type: Either "external" or "internal"
• created_at: Request creation timestamp
• updated_at: Last update timestamp
• done_at: Completion timestamp (null if not yet completed)

Examples

External withdrawal

{
  "id": 42,
  "currency_id": "eth",
  "type": "coin",
  "blockchain_key": "eth-testnet",
  "total": "0.005",
  "amount": "0.004939737914712714",
  "fee": "0.0000602620852872858",
  "blockchain_txid": null,
  "rid": "0xe684eddef350396d56b75ac998ee507cf80c7723",
  "state": "accepted",
  "internal_type": null,
  "confirmations": 0,
  "error_message": null,
  "transaction_type": "external",
  "created_at": "2026-02-24T13:01:59Z",
  "updated_at": "2026-02-24T13:01:59Z",
  "done_at": null
}

Internal withdrawal

{
  "id": 41,
  "currency_id": "bnb",
  "type": "coin",
  "blockchain_key": "bsc-testnet",
  "total": "0.05",
  "amount": "0.015966136305624095",
  "fee": "0.03403386369437590402",
  "blockchain_txid": "internal_transaction-0b3daa0207cecc",
  "rid": "internal_address-id871f311899",
  "state": "succeed",
  "internal_type": "address",
  "confirmations": null,
  "note": "Transfer User",
  "explorer_address": null,
  "error_message": null,
  "transaction_type": "internal",
  "created_at": "2026-02-24T12:49:45Z",
  "updated_at": "2026-02-24T12:49:45Z",
  "done_at": "2026-02-24T12:49:45Z"
}