Skip to main content

申请退款

基本信息

接口名称:申请退款状  态:已完成
接口路径:POST /api/refund更新时间:2025-03-17 23:56:26
Mock地址:https://apimock.e-buychina.com/mock/713/api/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电子现金支付最大长度: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。

优惠券不支持部分退款。

变更历史

变更日期变更内容
2025-03-17
api-id=37494