Skip to main content
POST
Create withdrawal request

Authorizations

token
string
header
required

Pass your API token in the token request header.

Body

application/json
amount
string
required

Amount to withdraw

Example:

"100.00"

network
enum<string>
required
Available options:
trx,
eth,
bnb,
sol
Example:

"trx"

currency
enum<string>
required
Available options:
USDT,
USDC,
ETH,
TRX,
BNB,
SOL
Example:

"USDT"

sender
enum<string>
required
Available options:
user,
exchange
Example:

"exchange"

external_id
string
required

Request ID in your system

Example:

"client_request_10001"

recipient_wallet
string
required

Recipient wallet

Example:

"TVx9EXAMPLE1bC"

comment
string

Comment for the withdrawal request. Displayed to the account owner when confirming the transaction in the bot, so they can see the purpose of the payment before approving it (max length = 160)

Example:

"Client withdrawal"

sender_wallet
string

Sender wallet (required param for sender = user). For sender = exchange - ignore this param.

Example:

"TQv5pEXAMPLE9xA"

fee_included
boolean

Default: fee_included=true. If fee_included is not specified or fee_included=true, the transfer fee will be deducted from the amount

Example:

true

refund_transaction_id
string

Pass this if the output is a refund for a blocked deposit. You can view the list of blocked deposits for a wallet in the refund array returned by the GET /wallets method.

Example:

"4"

Response

OK - withdrawal request was created successfully

code
string
required

Response code.

Example:

"200"

error_code
string | null
required

Application-level error code. Null for successful responses.

Example:

null

error_message
string | null
required

Human-readable error message. Null for successful responses.

Example:

null

data
object
required