跳转到主要内容
GET
Retrieve Balance

授权

x-auth-token
string
header
必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设为 account_id,可通过查询关联账户列表获取。如果省略或留空,请求将使用主账户执行。 更多信息参见关联账户

路径参数

currency
string
必填

指定获取余额所用的币种。仅可提供单一币种。币种代码遵循 ISO 4217 标准。

示例:

"USD"

响应

200 - application/json

余额返回成功。

balance_id
string
必填

账户余额 ID。

示例:

"72970a7c-7921-431c-b95f-3438724ba16f"

currency
string
必填

账户余额的币种。

示例:

"USD"

available_balance
string<number>
必填

可用余额。

示例:

"5000.25"

prepaid_balance
string<number>
必填

预付账户余额。

示例:

"3600.12"

margin_balance
string<number>
必填

保证金余额。

示例:

"10000.00"

frozen_balance
string<number>
必填

冻结余额。

示例:

"2353.25"

create_time
string<date/time>
必填

记录在系统中创建时的时间戳。时间戳遵循 ISO 8601 标准。

示例:

"2024-03-01T00:00:00+08:00"

last_trade_time
string
必填

对象更新时的最近成交时间。

示例:

"2024-03-21T17:17:32+08:00"

balance_status
enum<string>
必填

账户的余额状态。

  • ACTIVE:账户余额正常,可用于交易。
  • PENDING:账户余额等待激活或验证。
  • PROCESSING:账户余额正在更新或变更中。
  • CLOSED:账户余额已终止,不再可用。
可用选项:
ACTIVE,
PENDING,
PROCESSING,
CLOSED
示例:

"ACTIVE"