文档管理中心

您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。

指南与API参考API参考应用服务IAP Kit(应用内支付服务)REST API退款申请通知与处理返回退款审核结果

返回退款审核结果

功能介绍

此接口用于开发者将退款审核结果返回给IAP服务器。

场景描述

用户申请退款后,IAP服务会将退款审核信息回调给开发者服务器,开发者服务器根据退款审核信息处理退款后,调用该接口将退款审核结果告知IAP服务器。

接口原型

  • 承载协议: HTTPS POST

  • 接口方向: 开发者服务器 -> IAP服务器

  • 接口URL: {rootUrl}/post-sales/harmony/v1/transactions/refund/result

    说明:rootUrl具体请参见站点信息。

  • 数据格式:

    请求消息:Content-Type: application/json; charset=UTF-8

    响应消息:Content-Type: application/json; charset=UTF-8

请求参数

Request Header

展开
参数 是否必选 参数类型 描述
Content-Type 是 String 取值为:application/json;charset=UTF-8
Authorization 是 String 认证信息,使用JWT进行鉴权,具体请参见Authorization说明。

Request Body

展开
参数 是否必选 参数类型 描述
reviewType 是 Integer

审核结果。

1:同意退款

2:拒绝退款

refundBatchNo 是 String 退款工单号/批次号。
remark 否 String 审核结果备注,reviewType为2时需返回拒绝理由。
notifyTime 是 Long 通知时间,UTC时间戳,即自1970年1月1日0时起到商户通知的毫秒数。
applicationId 是 String 应用ID。
totalRefundAmount 否 Long 开发者同意的退款总金额,单位:分。reviewType为1时必填。
currency 否 String

币种,reviewType为1时必填。

CNY:人民币

reviewResultList 是 ReviewResult 订单退款明细,开发者同意退款时,需要明确返回每笔订单退款金额,如果部分订单拒绝退款,则退款金额返回0。

ReviewResult

展开
参数 是否必选 类型 说明
purchaseOrderId 是 String 订单中心订单号,按照系统通知的透传。最大长度256。
payMoney 是 Long 订单实付金额,单位:分。
refundMoney 是 Long 开发者同意的退款金额,单位:分。
consumptionStatus 否 Integer

权益使用状态,可选值。

1:未使用

2:部分使用

3:全部使用

ratio 否 Integer

权益使用程度,百分制,取值范围:0~100。

- 当consumptionStatus为1时,ratio必须为0

- 当consumptionStatus为2时,ratio不能为0或者100

- 当consumptionStatus为3时,ratio必须为100

playTime 否 Integer

权益使用时长,可选值。

0:未知

1:0-5分钟

2:5-60分钟

3:1-6小时

4:6-24小时

5:1-4天

6:4-16天

7:16天以上

请求示例

POST /post-sales/harmony/v1/transactions/refund/result
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ***.***.***
Accept: application/json
{
  "refundBatchNo": "***",
  "reviewType": 1,
  "notifyTime": 1741085489609,
  "applicationId": "***",
  "totalRefundAmount": 1290,
  "currency": "CNY",
  "reviewResultList": [
    {
      "purchaseOrderId": "***",
      "payMoney": 1290,
      "refundMoney": 1290
    }
  ]
}

响应参数

Response Header

展开
参数 是否必选 参数类型 描述
Content-Type 是 String 取值为:application/json;charset=UTF-8

Response Body

展开
参数 是否必选 参数类型 描述
returnCode 是 String

返回码。

0:成功

1:参数错误

990106:无效的审核类型

990107:审核订单与申请订单不匹配

990109:超期未处理工单不允许通过API审核

990110:当前退款状态不支持审核

returnDesc 是 String 响应描述。
subErrCode 否 String

如果returnCode不为0,表示具体错误原因。

200:鉴权信息不通过

211:JWT格式不正确

响应示例

HTTP/1.2 200 OK
Content-Type: application/json;charset=UTF-8
{
  "returnCode": "0",
  "returnDesc": "success"
}