Vessel Finance API
  1. Vessel REST API
  2. User
  3. Asset
Vessel Finance API
  • Introduction
  • General Info
  • HMAC Signature Guide
  • Poseidon Signature Guide
  • Internal Transfer Signature Guide
  • Error Code
  • Vessel REST API
    • Public
      • Market Data
        • 24hr Ticker Statistics
        • Kline / Candlestick Data
        • Order Book
        • Recent Trades List
        • Average Price
        • AMM Pool Last 24h Data
      • Exchange Data
        • Ticker Info
        • Asset Info
        • Trade Fee
        • AMM Pool Info
    • User
      • Asset
        • User Asset
          GET
        • Withdraw
          POST
        • Withdraw History
          GET
        • Deposit History
          GET
        • Claim History
          GET
        • Internal Transfer (Send)
          POST
        • Internal Transfer History
          GET
      • Order
        • Place Order
        • Cancel Order
        • Open Orders
        • Completed Orders
        • All Orders
        • Query Order
        • Modify Order
      • AMM
        • Add Liquidity
        • Remove Liquidity
        • Collect Fee
        • AMM Position
        • AMM Action History
      • Account
        • User Profile
        • User Trade List
  • Vessel WebSocket
    • Market
      • Order Book
      • K Line
      • Recent Trades
      • 24hr Ticker Statistics
      • Ticker Setting Upade
    • User
      • Authorize
      • Balance
      • Account
  1. Vessel REST API
  2. User
  3. Asset

Withdraw

Testnet Env
Testnet Env
POST
/api/v1/withdraw
Last modified:2024-10-15 06:23:56
Initiate a withdrawal request using the POST method.

Explanation of Fields:#

currency (string): Specifies the currency you want to withdraw. In this example, it is "USDT" for Tether.
amount (float): Indicates the amount you wish to withdraw. The value is provided as a floating-point number.
clientOrderId (string): Unique identifier for this withdrawal request. It helps in tracking and identifying the withdrawal transaction. In the example, "withdrawUSDT001" is used as the client order ID.

Note:#

Verify that the specified currency is valid and supported for withdrawal.
Double-check the withdrawal amount and ensure it is within the permissible limits.
Use a unique client order ID for each withdrawal to facilitate easy tracking of transactions.

Request

Header Params
VESSEL-API-KEY
string 
required
Default:
{{API_KEY}}
VESSEL-PASSPHRASE
string 
required
Default:
{{API_PASSPHRASE}}
VESSEL-SIGNATURE
string 
required
Use signRequest script to generate
VESSEL-TIMESTAMP
string 
required
Use signRequest script to set
Body Params application/json
assetName
string 
required
amount
string 
required
clientOrderId
string 
required
Example
{
  "currency": "USDT",
  "amount": 100,
  "clientOrderId": "withdrawUSDT001"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://testnet.trade.vessel.finance/api/v1/withdraw' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "currency": "USDT",
  "amount": 100.00,
  "clientOrderId": "withdrawUSDT001"
}'

Responses

🟢200OK
application/json
Body
msg
string 
required
The withdrawal request result. (eg. "success" )
Example
{
  "msg": "success"
}
Modified at 2024-10-15 06:23:56
Previous
User Asset
Next
Withdraw History
Built with