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

PaymentBudget

本页内容

API 付款可用预算的整体快照。账号与 API 应用两层约束同时生效,余额与预算分别判断。

如何阅读本模型

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

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

字段定义

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

字段必需说明
currency 是

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

类型:object

currency.code 是

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

类型:string

currency.unit 是

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

类型:string

currency.external_settlement 是

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

类型:string

查看取值约束
  • 固定值 payment_provider
currency.revision 是

此金额单位配置的修订标识。确认付款时使用报价返回的原值。

类型:string

查看取值约束
  • 格式 ^C[a-f0-9]{64}$
timezone 是

统计日期或预算周期采用的时区。

类型:string

查看取值约束
  • 固定值 Asia/Shanghai
observed_at 是

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

类型:integer

查看取值约束
  • 最小值 0
account 是

账号层的预算额度与使用情况。

类型:object

account.enabled 是

此选项或预算当前是否启用。

类型:boolean

account.currency_current 是

预算的金额单位是否与本站当前单位一致。

类型:boolean

account.single_limit 是

允许的单笔付款上限。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
account.daily 是

当日预算的上限、已用金额、剩余额度和重置时间。

类型:object

account.daily.limit 是

此预算周期允许使用的金额上限。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
account.daily.used 是

在当前预算周期中已使用的金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,12})\.[0-9]{2}$
account.daily.remaining 是

此预算周期当前剩余的可用金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
account.daily.resets_at 是

本预算周期结束并重置的时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0
account.monthly 是

当前月预算的上限、已用金额、剩余额度和重置时间。

类型:object

account.monthly.limit 是

此预算周期允许使用的金额上限。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
account.monthly.used 是

在当前预算周期中已使用的金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,12})\.[0-9]{2}$
account.monthly.remaining 是

此预算周期当前剩余的可用金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
account.monthly.resets_at 是

本预算周期结束并重置的时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0
application 是

当前 API 应用层的预算额度与使用情况。

类型:object

application.enabled 是

此选项或预算当前是否启用。

类型:boolean

application.currency_current 是

预算的金额单位是否与本站当前单位一致。

类型:boolean

application.single_limit 是

允许的单笔付款上限。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
application.daily 是

当日预算的上限、已用金额、剩余额度和重置时间。

类型:object

application.daily.limit 是

此预算周期允许使用的金额上限。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
application.daily.used 是

在当前预算周期中已使用的金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,12})\.[0-9]{2}$
application.daily.remaining 是

此预算周期当前剩余的可用金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
application.daily.resets_at 是

本预算周期结束并重置的时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0
application.monthly 是

当前月预算的上限、已用金额、剩余额度和重置时间。

类型:object

application.monthly.limit 是

此预算周期允许使用的金额上限。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
application.monthly.used 是

在当前预算周期中已使用的金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,12})\.[0-9]{2}$
application.monthly.remaining 是

此预算周期当前剩余的可用金额。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
application.monthly.resets_at 是

本预算周期结束并重置的时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0
financial_health 是

付款能力的当前状态。

类型:object

financial_health.payment_quarantined 是

付款是否因需核对账务而暂停。

类型:boolean

financial_health.checked_at 是

最近一次检查时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0

相关接口

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

作为成功响应