Withdraw History

Testnet Env

GET

/api/v1/gateway/user/history/withdraw

Last modified:2024-10-15 06:23:56

Withdraw History provides a list of historical withdrawal transactions on our platform.

Request

Query Params

assetName

string

optional

Specifies the name of the asset for which you want to retrieve withdraw history. For example, "USDT", "USDC", or "WBTC".

Example:

WBTC

status

string

optional

The current status of the withdrawal request. Possible values include:
SUCCESS - The withdrawal request has been successfully processed.
PENDING - The withdrawal request is pending and has not been processed yet.
FAILED - The withdrawal request has failed.

withdrawOrderId

string

optional

The id of the withdrawal in Vessel.

startTime

string

optional

Specifies the starting time (Unix timestamps in milliseconds & UTC) for retrieving withdraw history. Only withdrawals made after this timestamp will be included in the result.

endTime

string

optional

Specifies the ending time (Unix timestamps in milliseconds & UTC) for retrieving withdraw history. Only withdrawals made before this timestamp will be included in the result.

limt

string

optional

Specifies the maximum number of deposit history entries to retrieve (Default is 500. Maximum is 1000).

fromID

string

optional

The ID from which to start fetching records. In this API, since the order is descending (backwards), if fromId is set to 100, the system will return records starting from the ID just before 100 and continue moving backwards. The retrieval will proceed until the limit is reached.

Header Params

VESSEL-API-KEY

string

required

Default:

VESSEL-PASSPHRASE

string

required

Default:

VESSEL-SIGNATURE

string

required

Use signRequest script to generate

VESSEL-TIMESTAMP

string

required

Use signRequest script to set

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/gateway/user/history/withdraw?assetName=WBTC&status=&startTime&endTime&limt&fromID' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK

application/json

Body

withdraws

array [object {9}]

required

An array containing details for each historical withdrawal transaction.

string

required

A unique identifier for the withdrawal transaction.

globalEventId

string

required

Global event identifier associated with the withdrawal in Vessel.

amount

string

required

Amount of cryptocurrency withdrawn.

transactionFee

string

required

Transaction fee associated with the withdrawal.

assetName

string

required

Name of asset (e.g., "WBTC" or "USDT").

status

string

required

Current status of the withdrawal request. Possible values include:
SUCCESS - The withdrawal request has been successfully processed.
PENDING - The withdrawal request is pending and has not been processed yet.
Failed - The withdrawal request has failed.

address

string

required

Destination address to which the cryptocurrency was withdrawn.

timestamp

string

required

Timestamp when the withdrawal transaction was initiated (Unix timestamps in milliseconds & UTC).

withdrawOrderId

string

required

A unique identifier assigned to the withdrawal order.

Example

{
  "withdraws": [
    {
      "id": "1728711700276088",
      "globalEventId": "7853",
      "amount": "0.01",
      "transactionFee": "0",
      "assetName": "ETH",
      "status": "PENDING",
      "address": "0x3ad8ccb270d84808ca16e2be3594c9eb723210f8",
      "timestamp": "1728718021747",
      "withdrawOrderId": "1728718021742"
    },
    {
      "id": "1728711700276031",
      "globalEventId": "664",
      "amount": "0.01",
      "transactionFee": "0",
      "assetName": "WBTC",
      "status": "SUCCESS",
      "address": "0x3ad8ccb270d84808ca16e2be3594c9eb723210f8",
      "timestamp": "1728713256525",
      "withdrawOrderId": "1728713256519"
    }
  ]
}

Modified at 2024-10-15 06:23:56

Withdraw

Deposit History