跳转到主要内容
1签 (OneSign)

AccountBalance

本页内容

自己账号的可用余额快照。金额必须与 currency 一起解释,不能仅凭余额判断本次 API 付款一定可执行。

如何阅读本模型

先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。

应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。

字段定义

“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。

字段必需说明
available 是

查询时账户可用的站内余额。

类型:string

查看取值约束
  • 格式 ^-?[0-9]{1,11}\.[0-9]{2}$
currency 是

站内金额单位及展示信息,按本站配置解释所有金额。

类型:object

currency.code 是

站内金额单位代码,例如 CNY、USD 或 POINT。

类型:string

currency.unit 是

站点配置的金额单位显示名称。

类型:string

currency.external_settlement 是

外部支付的结算币种以支付渠道为准。

类型:string

observed_at 是

余额或预算的观测时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0

相关接口

下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。

作为成功响应