HTX Will Add Two Response Fields in "GET /v1/query/deposit-withdraw"

HTX will adjust the existing REST API "GET /v1/query/deposit-withdraw" as follows:

1. Add two response fields  "error-code" and "error-message" to return the reasons of the withdrawal failure.

2. Add two values "verifying" and "failed" for the response field "state" to explain the progress of risk verification.

Effective date: June 11, 2020 (GMT+8)

All the changes will be updated on https://huobiapi.github.io/docs/spot/v1/en/

HTX
June 11, 2020

 

Search for Existed Withdraws and Deposits

GET  /v1/query/deposit-withdraw

Request Parameters

No change

Response Content

Field Data Type Description
id integer Transfer id
type string Define transfer type to search, possible values: [deposit, withdraw]
currency string The crypto currency to withdraw
tx-hash string The on-chain transaction hash
chain string Block chain name
amount float The number of crypto asset transfered in its minimum unit
address string The deposit or withdraw source address
address-tag string The user defined address tag
fee float Withdraw fee
state string The state of this transfer (see below for details)
error-code string Error code for withdrawal failure, only returned when the type is "withdraw" and the state is "reject", "wallet-reject" and "failed".
error-msg string Error description of withdrawal failure, only returned when the type is "withdraw" and the state is "reject", "wallet-reject" and "failed".
created-at integer The timestamp in milliseconds for the transfer creation
updated-at integer The timestamp in milliseconds for the transfer's latest update

List of possible withdraw state

State Description
verifying Awaiting verification
failed verification failed
submitted Withdraw request submitted successfully
reexamine Under examination for withdraw validation
canceled Withdraw canceled by user
pass Withdraw validation passed
reject Withdraw validation rejected
pre-transfer Withdraw is about to be released
wallet-transfer On-chain transfer initiated
wallet-reject Transfer rejected by chain
confirmed On-chain transfer completed with one confirmation
confirm-error On-chain transfer faied to get confirmation
repealed Withdraw terminated by system

List of possible deposit state

No change

 

API users should evaluate the business impact caused by the adjustment, further to make relevant change in client’s application.

All the changes will be updated on HTX API Docs on the effective date.