接口文档 / 收费接口

收费单退款(支持部分退)

只退指定商品
chargeForms 中只传需要退的商品,needRefundFee 和 refundFee 传这些商品的金额总和。

退到不同支付方式
例如全退 100 元,但要退到两个支付方式:
1. 第一次退费时传所有需退商品,传 needRefundFee=100、refundFee=50,退到支付方式 A。此时商品已全部退完,但仍有 50 元未退。
2. 第二次退费不再传商品,传 needRefundFee=0、refundFee=50,退到支付方式 B。

PUT/api/v2/open-agency/charge/{chargeSheetId}/refund在线调试

请求参数

名称说明类型
Path 参数
chargeSheetId必填

收费单ID

string
Body 参数
operatorId必填

操作人ID

示例:00000000000000000000000000000000

string
needRefundFee可选

收费项需要退费金额(如果不传默认为收费单的实收金额),最大值为 chargeForms 中商品实收金额总和

number
refundFee可选

本次退费金额(如果不传默认为收费单的实收金额),最大值为 [needRefundFee] + 欠退金额

number
payMode可选

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项(如果不传则默认为任意一次收费交易的支付方式)

示例:1

最小:1

integer

请求示例

json
{
  "operatorId": "00000000000000000000000000000000",
  "needRefundFee": 0,
  "refundFee": 0,
  "payMode": 1,
  "chargeForms": [
    {
      "id": "00000000000000000000000000000000",
      "chargeFormItems": [
        {
          "id": "00000000000000000000000000000000",
          "unitCount": 1,
          "doseCount": 1
        }
      ]
    }
  ]
}

响应参数

名称说明类型
Body 参数
data可选

数据

object
id必填

收费单ID

string
status必填

收费单状态 0:未收费 1:部分收费 2:已收费 3:部分退费 4:已退费

示例:2

integer
statusName必填

状态名称

示例:已收费

string
refundFee必填

本次已退金额

示例:10

number
refundedFee必填

累积已退金额

示例:20

number

响应示例

json
{
  "data": {
    "id": "string",
    "status": 2,
    "statusName": "已收费",
    "refundFee": 10,
    "refundedFee": 20
  },
  "error": null
}

业务失败包装示意

json
{
  "data": null,
  "error": {
    "code": 11003,
    "message": "不支持的授权类型{grantType}"
  }
}

查看 HTTP 状态与业务码排查

ABC 开放平台 · 诊所管家

如有疑问,请扫码加入企业微信群咨询。

企业微信群二维码
没有匹配结果

诊所管家