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

RefundReceipt

本页内容

已完成退款的回执。核对原订单、实际入账、撤销天数和剩余权益,不重复发起同一笔退款。

如何阅读本模型

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

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

字段定义

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

字段必需说明
id 是

该条记录的公开标识。调用后续接口时请完整保留,包括前缀。

类型:string

查看取值约束
  • 格式 ^R[a-f0-9]{32}$
app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string

查看取值约束
  • 格式 ^A[a-f0-9]{32}$
order_id 是

订单 ID,可从付款回执获得。

类型:string

查看取值约束
  • 格式 ^O[a-f0-9]{32}$
quote_id 是

本次购买或扩容的报价 ID。两种报价分别在各自的接口下查询。

类型:string

查看取值约束
  • 格式 ^Q[a-f0-9]{32}$
state 是

当前记录的处理状态或请求筛选的状态。

类型:string

查看取值约束
  • 固定值 refunded
amount 是

以站内单位表示的金额,小数字符串应原样传递。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,8})\.[0-9]{2}$
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}$
balance_before 是

本次扣款或退款前的站内余额。

类型:string

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

本次扣款或退款后的站内余额。

类型:string

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

退款完成时间,Unix 秒。

类型:integer

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

退款撤销的签名服务天数。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 3650
sign_expires_at 是

签名权益的到期时间,Unix 秒。

类型:integer

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

退款入账的目的地,为原付款账号站内余额。

类型:string

查看取值约束
  • 固定值 site_balance
budget_restored 是

退款后是否恢复原 API 付款预算。

类型:boolean

查看取值约束
  • 固定值 false

相关接口

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

作为成功响应