Wallet Endpoints

Withdraw (USER_DATA)

• POST /api/v1/account/withdraw

Submit a withdraw request.

Weight: 1

Response

{
  "success": true,
  "needBrokerAudit": false, // Do you need a brokerage review?
  "id": "423885103582776064", // Withdrawal successful order id
  "refuseReason": "" // failure rejection reason
}

Parameters

Name	Type	Mandatory	Description
coin	STRING	YES	asset
clientOrderId	LONG	YES	client id for withdraw
address	STRING	YES	Recipient identifier. When addressType is empty or BLOCK_CHAIN, this is an on-chain withdrawal address (Note: the on-chain withdrawal address must be maintained in the common address list on the PC or APP). When addressType is PHONE_NUMBER, this is the phone number used for an internal transfer and must be formatted as country code phone number with a space between the country code and phone number, for example 86 13812345678. When addressType is EMAIL or UID, this is the email address or UID used for an internal transfer
addressExt	STRING	NO	tag
quantity	DECIMAL	YES	Number of coin withdrawals
chainType	STRING	NO	chain type, The chainType of USDT is OMNI ERC20 TRC20 respectively, and the default is OMNI
addressType	STRING	NO	Recipient identifier type. Defaults to BLOCK_CHAIN when empty. Supported enum names: BLOCK_CHAIN, PHONE_NUMBER, EMAIL, UID. Numeric enum values and lowercase names are not supported. PHONE_NUMBER, EMAIL, and UID indicate internal transfers
vaspCode	STRING	NO	vasp code
targetPersonFirstName	STRING	NO	target person first name
targetPersonLastName	STRING	NO	target person last name

Request Examples

On-chain withdrawal:

POST /api/v1/account/withdraw
Content-Type: application/x-www-form-urlencoded

coin=USDT&clientOrderId=123456&address=0x815bF1c3cc0f49b8FC66B21A7e48fCb476051209&quantity=10&chainType=ERC20&addressType=BLOCK_CHAIN&timestamp=1780000000000&signature=<signature>

Internal transfer by phone number:

POST /api/v1/account/withdraw
Content-Type: application/x-www-form-urlencoded

clientOrderId=123457&address=86 13812345678&coin=USDT&quantity=10&addressType=PHONE_NUMBER&timestamp=1780000000000&signature=<signature>

Use clientOrderId=123457&address=86 13812345678&coin=USDT&quantity=10&addressType=PHONE_NUMBER&timestamp=1780000000000 as the payload when calculating signature. The address value contains a normal space between the country code and phone number.

Internal transfer by email:

POST /api/v1/account/withdraw
Content-Type: application/x-www-form-urlencoded

clientOrderId=123458&address=user@example.com&coin=USDT&quantity=10&addressType=EMAIL&timestamp=1780000000000&signature=<signature>

Internal transfer by UID:

POST /api/v1/account/withdraw
Content-Type: application/x-www-form-urlencoded

clientOrderId=123459&address=10000001&coin=USDT&quantity=10&addressType=UID&timestamp=1780000000000&signature=<signature>

Withdrawal records (USER_DATA)

• GET /api/v1/account/withdrawOrders (HMAC SHA256)

Weight: 5

Response

[
    {
        "time": "1536232111669",
        "id ": "90161227158286336",
        "accountId": "517256161325920",
        "coinId ": "BHC",
        "coinName": "BHC",
        "address": "0x815bF1c3cc0f49b8FC66B21A7e48fCb476051209",
        "addressExt": "address tag",
        "quantity": "14", // Withdrawal amount
        "arriveQuantity": "14", // Amount received
        "statusCode": "PROCESSING_STATUS",
        "status": 3,
        "txId ": "",
        "txIdUrl ": "",
        "walletHandleTime": "1536232111669",
        "feeCoinId ": "BHC",
        "feeCoinName ": "BHC",
        "fee": "0.1",
        "requiredConfirmTimes ": 0, // Number of confirmation requests
        "confirmTimes ": 0, // number of confirmations
        "kernelId": "", // Exclusive to BEAM and GRIN
        "isInternalTransfer": false // Whether internal transfer
    }
]

Parameters

Name	Type	Mandatory	Description
coin	STRING	NO	asset
startTime	LONG	NO	start timestamp
endTime	LONG	NO	end timestamp
fromId	LONG	NO	From which OrderId to start fetching
withdrawOrderId	LONG	NO	Withdrawal order ID
limit	INT	NO	default 500; maximum 1000
recvWindow	LONG	NO	recv window
timestamp	LONG	YES	Timestamp

Deposit Address (USER_DATA)

• GET /api/v1/account/deposit/address (HMAC SHA256)

Fetch deposit address with network.

Weight: 1

Response

    {
        "canDeposit": false, //Is it possible to recharge
        "address": "0x815bF1c3cc0f49b8FC66B21A7e48fCb476051209",
        "addressExt": "address tag",
        "minQuantity": "100", //minimum amount
        "requiredConfirmTimes ": 1, //Arrival confirmation number
        "canWithdrawConfirmNum ": 12, //Withdrawal confirmation number
        "chainType": "ERC20"
    }

Parameters

Name	Type	Mandatory	Description
coin	STRING	YES	asset
chainType	STRING	YES	chain type, The chainType of USDT is OMNI ERC20 TRC20 respectively, and the default is OMNI

Deposit History (USER_DATA)

• GET /api/v1/account/depositOrders (HMAC SHA256)

Weight: 5

Response

[
  {
        "id": 100234,
        "coin": "EOS",
        "coinName": "EOS",
        "address": "deposit2bb",
        "addressTag": "19012584",
        "fromAddress": "clarkkent",
        "fromAddressTag": "19029901",
        "time": 1499865549590,
        "quantity": "1.01",
        "status": "2", // 2=SUCCESS, 11=REJECT, 12=AUDIT
        "statusCode": "DEPOSIT_CAN_WITHDRAW",
        "requiredConfirmTimes": "5",
        "confirmTimes": "5",
        "txId": "98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC",
        "txIdUrl": ""
  }
]

Parameters

Name	Type	Mandatory	Description
coin	STRING	NO	asset
startTime	LONG	NO	start timestamp
endTime	LONG	NO	end timestamp
fromId	LONG	NO	From which Id to start crawling
limit	INT	NO	Default 500; Max 1000
recvWindow	LONG	NO	recv window
timestamp	LONG	YES	Timestamp

Notes:

• If fromId is set, it will filter the orders smaller than id. Otherwise, the most recent order information will be returned.