Skip to main content

退款

基本信息

接口名称:退款状  态:已完成
接口路径:POST /paas/micro/cashier/refund更新时间:2023-07-17 21:30:50
Mock地址:https://apimock.e-buychina.com/mock/587/paas/micro/cashier/refund

请求参数

Headers:

参数名称参数值是否必填
Content-Typeapplication/json

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型最大长度:50
最小长度:1
Mock:refund
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject请求报文
  outTradeNostring下单时原外部订单号最大长度:32
最小长度:1
Mock:@string
  refundTradeNostring退款交易编号,格式:YYYYMMDD+随机数最大长度:32
最小长度:1
Mock:@string
  tradeTimestring交易时间,格式YYYYMMDD,不填默认当天最大长度:8
Mock:@string
  goodsDetailobject退产品信息
    goodsIdstring商品ID,外部编号最大长度:32
最小长度:1
Mock:@string
    goodsNamestring商品名称最大长度:50
Mock:@string
    goodsCodestring商品编码,内部编号最大长度:32
Mock:@string
    goodsNumnumber数量Mock:@integer
  refundMethodarray长度只能小于等于1,自定义退款方式和退款金额,此字段存在将不执行refundAmount
    assetTypestring资产类型,枚举。cash电子现金支付,coupon优惠券,cashcard现金卡,储值卡,points积分最大长度:20
最小长度:1
Mock:@string
    refundAmountinteger具体资产类型的退款金额,非券类交易部分退款必填Mock:@integer

返回数据

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
successboolean交易成功与否Mock:@boolean
actionstring交易类型最大长度:50
最小长度:1
Mock:refund
timestampnumber返回时间戳Mock:@timestamp
errorCodestring错误码最大长度:50
Mock:@word
errorMessagestring错误描述最大长度:50
Mock:@csentence
signTypestring签名类型最大长度:20
Mock:sha256
signstring签名值最大长度:500
Mock:@natural
contentobject返回报文
  outTradeNostring流水号最大长度:64
最小长度:1
Mock:@string
  refundTimestring退款时间最大长度:19
最小长度:1
Mock:@date
  refundAmountstring退款金额最大长度:11
最小长度:1
Mock:@integer
  cardRefundobject卡退款明细
    refundAmountstring退款金额最大长度:11
最小长度:1
    refundStatusstring退款状态最大长度:32
最小长度:1
    useListarray
      codestring
      errorCodestring
      errorMsgstring
      paidAmountstring
      useRulestring
      fromGoodsIdsstring
      forGoodsIdsstring
  couponRefundobject券退款明细
    refundAmountstring退款金额最大长度:11
最小长度:1
    refundStatusstring退款状态最大长度:32
最小长度:1
    useListarray
      codestring
      errorCodestring
      errorMsgstring
      paidAmountstring
      useRulestring
      fromGoodsIdsstring
      forGoodsIdsstring
  pointsRefundobject积分退款明细
    refundAmountstring退款金额最大长度:11
最小长度:1
    refundStatusstring退款状态最大长度:32
最小长度:1
    useListarray
      codestring
      errorCodestring
      errorMsgstring
      paidAmountstring
      useRulestring
      fromGoodsIdsstring
      forGoodsIdsstring
  cashRefundobject电子现金退款明细
    refundAmountstring退款金额最大长度:11
最小长度:1
    refundStatusstring退款状态最大长度:32
最小长度:1

备注

退款请求可以选择整单退或者单资产退款,refundMethod的长度不支持大于1。

优惠券不支持部分退款。

变更历史

变更日期变更内容
2023-07-17
2023-03-06
2023-03-06
2022-02-23
2022-02-23
2021-09-09
2021-09-03
2021-07-23
2021-07-22
2021-07-07
2021-07-07
2021-06-07
2021-06-03
2021-06-03
2021-06-03
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-05-17
2021-05-12
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
api-id=27787