提款

API 权限范围

GET 请求需要 查看提款历史 权限，POST 请求需要 执行提款 权限。

提款

属性名称	类型	描述	示例
id	number	存款的 ID
customer_id	string	客户 ID
asset_uuid	string	货币的 UUID
amount	string	金额
state	string	提款状态，取值为 PENDING（待处理）、COMPLETED（已完成）、FAILED（失败）、CANCELLED（已取消）
recipient_id	string	收款方的 ID
completed_at	string	完成时间
inserted_at	string	提款时间
is_internal	boolean	是否为内部提款
target_address	string	目标地址
note	string	备注内容

获取用户提款记录

需要钱包的读取权限

GET /viewer/withdrawals

参数

名称	类型	必需	描述	示例
page_token	string	否	请求此页面后的分页令牌
limit	string	否	默认 50，最大 200
kind	string	否	类型：on_chain（链上），off_chain（链外），internal（内部）
asset_symbol	string	否	货币符号	BTC

响应为提款数组：

{
	"data": [{
		"id": 10,
		"customer_id": "10",
		"asset_symbol": "ETH",
		"amount": "5",
		"state": "COMPLETED",
		"note": "2018-03-15T16:13:45.610463Z",
		"txid": "0x4643bb6b393ac20a6175c713175734a72517c63d6f73a3ca90a15356f2e967da0",
		"completed_at": "2018-03-15T16:13:45.610463Z",
		"inserted_at": "2018-03-15T16:13:45.610463Z",
		"is_internal": true,
		"target_address": "0x4643bb6b393ac20a6175c713175734a72517c63d6f7"
	}],
	"page_token":"eyJvZmZzZXQiOjEwMCwia2luZCI6IlRSQU5TRkVSIn0="
}

获取单个提款记录

GET /viewer/withdrawals/{guid}

参数

名称	类型	必需	描述	示例
guid	string	是	GUID	c37173f4-751f-4cc1-9904-c1041dcae4f7

响应为提款对象：

{
    "code":0,
    "message":"",
    "data": {
		"id": 10,
		"customer_id": "10",
		"asset_symbol": "ETH",
		"amount": "5",
		"state": "COMPLETED",
		"note": "2018-03-15T16:13:45.610463Z",
		"txid": "0x4643bb6b393ac20a6175c713175734a72517c63d6f73a3ca90a15356f2e967da0",
		"completed_at": "2018-03-15T16:13:45.610463Z",
		"inserted_at": "2018-03-15T16:13:45.610463Z",
		"is_internal": true,
		"target_address": "0x4643bb6b393ac20a6175c713175734a72517c63d6f7"
	}
}

创建用户提款

需要钱包的写入权限

POST /viewer/withdrawals

参数

名称	类型	必需	描述	示例
symbol	string	是	货币符号	BTC
target_address	string	是	白名单中的目标地址	3PumsXwUSakZomHXMcY93RrVRJ7PAi2ida
amount	string	是	金额	2.52
memo	string	否	备注
guid	string	否	唯一标识符 GUID	c37173f4-751f-4cc1-9904-c1041dcae4f7
gateway_name	string	否	提款货币所属的链	如果您希望提取 USDT 到以太坊链，symbol 应为 'USDT'，gateway_name 应为 'Ethereum'。可用的网关名称：Bitcoin，Ethereum，Tron，EOS，Mixin

响应为提款对象：

{
    "code":0,
    "message":"",
    "data": {
		"id": 10,
		"customer_id": "10",
		"asset_symbol": "ETH",
		"amount": "5",
		"state": "COMPLETED",
		"note": "2018-03-15T16:13:45.610463Z",
		"txid": "0x4643bb6b393ac20a6175c713175734a72517c63d6f73a3ca90a15356f2e967da0",
		"completed_at": "2018-03-15T16:13:45.610463Z",
		"inserted_at": "2018-03-15T16:13:45.610463Z",
		"is_internal": true,
		"target_address": "0x4643bb6b393ac20a6175c713175734a72517c63d6f7"
	}
}

取消单个提款

POST /viewer/withdrawals/{guid}/cancel

这是一个异步 API，返回 code 0 并不意味着最终成功，建议通过获取 API 获取最终状态

参数

名称	类型	必需	描述	示例
guid	string	是	GUID	c37173f4-751f-4cc1-9904-c1041dcae4f7

响应：

{
    "code":0,
    "message":"cancel request submitted",
    "data": null
}