跳转到主要内容
GET
Retrieve Balance

授权

x-auth-token
string
header
必填

UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

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

x-idempotency-key
string<uuid>
必填

用于保持操作幂等性的唯一标识符(UUID),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。

路径参数

currency
string
必填

余额查询的币种代码

示例:

"SGD"

响应

200 - application/json

成功获取余额

balance_id
string
必填

账户余额 ID

示例:

"4a2dd9f0-bfe9-432b-be2e-4d5af5d0b448"

currency
string<iso-4217>
必填

账户余额的币种

示例:

"SGD"

available_balance
string
必填

当前可用余额

示例:

"1000.00"

payable_balance
string
必填

可付账户余额

示例:

"950.00"

pending_balance
string
必填

待处理余额

示例:

"50.00"

reserved_balance
string
必填

预留余额

示例:

"0.00"

margin_balance
string
必填

保证金余额

示例:

"0.00"

frozen_balance
string
必填

冻结资金

示例:

"0.00"