OrderRefund
本页内容
原订单当前的退款资格与处理状态。先判断 eligible 和 deadline,再确认退款或查询已完成回执。
如何阅读本模型
先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。
应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。
字段定义
“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。
| 字段 | 必需 | 说明 |
|---|---|---|
app_id |
是 | 业务应用的完整 ID,来自列出应用或预留新应用的响应。 查看取值约束
|
order_id |
是 | 订单 ID,可从付款回执获得。 查看取值约束
|
state |
是 | 原订单的退款处理状态;是否可新申请还要检查 eligible。 查看取值约束
|
eligible |
是 | 按查询时的订单、时间和设备条件,当前是否具备退款资格。 |
amount |
是 | 以站内单位表示的金额,小数字符串应原样传递。 查看取值约束
|
currency |
是 | 站内金额单位及展示信息,按本站配置解释所有金额。 |
currency.code |
是 | 站内金额单位代码,例如 CNY、USD 或 POINT。 |
currency.unit |
是 | 站点配置的金额单位名称。 |
currency.external_settlement |
是 | 外部支付的结算币种以支付渠道为准。 查看取值约束
|
currency.revision |
是 | 此金额单位配置的修订标识。确认付款时使用报价返回的原值。 查看取值约束
|
days |
是 | 所购买的服务天数,按天 SKU 须在站点当前允许范围内。 查看取值约束
|
deadline |
是 | 本笔订单当前退款窗口的截止时间,Unix 秒;实际申请时会重新检查资格。 查看取值约束
|
message |
是 | 供人阅读的业务说明。程序分支应使用状态或错误码。 查看取值约束
|
receipt |
是 | 已经完成退款时的原回执;未退款时为空。 |
receipt.id |
是 | 该条记录的公开标识。调用后续接口时请完整保留,包括前缀。 查看取值约束
|
receipt.app_id |
是 | 业务应用的完整 ID,来自列出应用或预留新应用的响应。 查看取值约束
|
receipt.order_id |
是 | 订单 ID,可从付款回执获得。 查看取值约束
|
receipt.quote_id |
是 | 本次购买或扩容的报价 ID。两种报价分别在各自的接口下查询。 查看取值约束
|
receipt.state |
是 | 当前记录的处理状态或请求筛选的状态。 查看取值约束
|
receipt.amount |
是 | 以站内单位表示的金额,小数字符串应原样传递。 查看取值约束
|
receipt.currency |
是 | 站内金额单位及展示信息,按本站配置解释所有金额。 |
receipt.currency.code |
是 | 站内金额单位代码,例如 CNY、USD 或 POINT。 |
receipt.currency.unit |
是 | 站点配置的金额单位名称。 |
receipt.currency.external_settlement |
是 | 外部支付的结算币种以支付渠道为准。 查看取值约束
|
receipt.currency.revision |
是 | 此金额单位配置的修订标识。确认付款时使用报价返回的原值。 查看取值约束
|
receipt.balance_before |
是 | 本次扣款或退款前的站内余额。 查看取值约束
|
receipt.balance_after |
是 | 本次扣款或退款后的站内余额。 查看取值约束
|
receipt.refunded_at |
是 | 退款完成时间,Unix 秒。 查看取值约束
|
receipt.revoked_days |
是 | 退款撤销的签名服务天数。 查看取值约束
|
receipt.sign_expires_at |
是 | 签名权益的到期时间,Unix 秒。 查看取值约束
|
receipt.refund_destination |
是 | 退款入账的目的地,为原付款账号站内余额。 查看取值约束
|
receipt.budget_restored |
是 | 退款后是否恢复原 API 付款预算。 查看取值约束
|
refund_destination |
是 | 退款入账的目的地,为原付款账号站内余额。 查看取值约束
|
budget_restored |
是 | 退款后是否恢复原 API 付款预算。 查看取值约束
|
confirmation |
是 | 确认撤销订单权益的值,执行退款时按接口要求提交。 查看取值约束
|
相关接口
下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。