跳转到主要内容
GET
List Address Book

授权

x-auth-token
string
header
必填

UQPay 提供的用于登录的 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设置为 account_id,可通过 List Connected Accounts 接口获取。若省略或为空,则请求以主账户身份执行。 更多信息参见 Connected Accounts。

查询参数

page_num
integer
默认值:1

页码,默认 1

必填范围: x >= 1
page_size
integer
默认值:10

每页条数,默认 10

必填范围: x >= 1
currency
string

按币种筛选

network
string

按网络筛选

address_type
enum<integer>

按地址类型筛选(1000=交易所,2000=个人)

可用选项:
1000,
2000
address_status
integer

按地址状态筛选

verification_status
enum<integer>

按验证状态筛选(1=已验证,2=失败)

可用选项:
1,
2
wallet_address
string

按钱包地址筛选

address_label
string

按地址标签筛选

address_kind
enum<string>
默认值:whitelist

返回哪一类条目。whitelist(默认)返回提现目的地址;deposit_sender 返回通过 Submit Deposit Sender Travel Rule 补录的充值来源条目。不传则保持仅返回提现地址的原有行为。

可用选项:
whitelist,
deposit_sender

响应

200 - application/json

成功获取地址簿列表

code
integer
必填
示例:

200

message
string
必填
示例:

"Success"

data
object
必填