pay.refunds

搜索退款单

• 请求路由: pay.refunds
• 交互模型: Request Stream
• 访问限制: 无

请求

RSocket.rs({
  "route" : "pay.refunds",
  "args" : {
    "search" : {
      "keyword" : "189",
      "success" : true
    },
    "pg" : {
      "page" : 1,
      "size" : 10
    }
  }
});

请求参数

名称	类型	必须	说明
search	Object	否	查询参数
search.success	Boolean	否	是否退款 - false 未退款 - true 已退款
search.outTradeNo	String	否	订单号
search.refundMethod	Number	否	退款方式 - 0 财付通 - 1 线下 - 2 其他
search.refundSource	String	否	退款来源 - order 订单
search.refundTimeFrom	String	否	起始退款时间
search.refundTimeTo	String	否	结束退款时间
search.keyword	String	否	模糊匹配关键字
search.from	String	否	查询起始时间，时间样式为RFC3339格式，如：2019-04-18T00:13:39.649Z
search.to	String	否	查询终止时间，时间样式为RFC3339格式，如：2019-04-19T00:13:39.649Z
pg	Object	否	分页参数
pg.page	Number	否	页码，首页从0开始
pg.size	Number	否	每页记录，默认为10
pg.sort	String[]	否	排序字段清单，默认为升序，需要指定降序时在字段名后面添加desc并用分号隔开。 例如：["id", "crDate;desc"]

返回

退款单

[
  {
    "crDate" : "2023-12-29T06:32:09.299Z",
    "tenantId" : "mzd",
    "refundNo" : "RFD202312291432255",
    "paymentPlatform" : "wexin",
    "outTradeNo" : "CCO202312291421583204",
    "subOutTradeNo" : "CCO202312291421583204",
    "spMchid" : "1639598979",
    "subMchid" : "1657580193",
    "applicationId" : "S202312292920",
    "payer" : {
      "targetType" : "CUSTOMER",
      "targetId" : "18000010001@mzd",
      "targetName" : "测试鱼"
    },
    "payee" : {
      "targetType" : "COMPANY",
      "targetId" : "CN1037",
      "targetName" : "红牌客运"
    },
    "amount" : 10,
    "method" : 0,
    "source" : "order",
    "reason" : "测试退全款并取消订单，并开启分账",
    "payRemark" : "正常退款",
    "attachments" : [ ],
    "request" : {
      "appId" : "wxd0be3263c2bdd6bf",
      "subMchid" : "1657580193",
      "orderNo" : "CCO202312291421583204",
      "refundNo" : "RFD202312291432255",
      "reason" : "测试退全款并取消订单，并开启分账",
      "refundAmount" : 10,
      "orderAmount" : 10,
      "currency" : "CNY"
    },
    "response" : {
      "refundId" : "50302908022023122908604358153",
      "outRefundNo" : "RFD202312291432255",
      "transactionId" : "4200002129202312298598528023",
      "outTradeNo" : "CCO202312291421583204",
      "userReceivedAccount" : "支付用户零钱",
      "successTime" : "2023-12-29T06:33:08Z",
      "createTime" : "2023-12-29T06:33:01Z",
      "status" : "SUCCESS",
      "refundAccount" : "REFUND_SOURCE_SUB_MERCHANT",
      "amount" : {
        "total" : 10,
        "refund" : 10,
        "from" : [ ],
        "payerTotal" : 10,
        "payerRefund" : 10,
        "discountRefund" : 0,
        "currency" : "CNY"
      },
      "promotionDetail" : [ ],
      "spMchid" : "1639598979",
      "subMchid" : "1657580193"
    },
    "id" : "RFD202312291432255"
  }
]

返回属性

名称	类型	说明
refundNo	String	退款单号
paymentPlatform	String	所属支付平台 weixin - 微信支付 douyin - 抖音 alipay - 支付宝
outTradeNo	String	相关订单编号
subOutTradeNo	String	合单支付时指定子订单编号
spMchid	String	服务商号
subMchid	String	子商户编号
applicationId	String	申请编号
payer	Object	订单支付者平台帐户信息
payer.targetType	String	帐户类型 由调用方根据分账方身份类型定义，例如：COMPANY,PARTNER,CHANNEL等
payer.targetId	String	targetType下的帐户标识
payer.targetName	String	帐户名
payee	Object	订单收款方平台帐户信息
payee.targetType	String	帐户类型 由调用方根据分账方身份类型定义，例如：COMPANY,PARTNER,CHANNEL等
payee.targetId	String	targetType下的帐户标识
payee.targetName	String	帐户名
refundPayer	Object	退款出资方 未指定时默认为订单收款人
refundPayer.targetType	String	帐户类型 由调用方根据分账方身份类型定义，例如：COMPANY,PARTNER,CHANNEL等
refundPayer.targetId	String	targetType下的帐户标识
refundPayer.targetName	String	帐户名
amount	Number	退款金额
offlineAmount	Number	其中线下退款部分的金额 必须不能大于amount。大于0时，在退款支付操作后，会自动生成线下支付
method	Number	退款方式 - 0 财付通 - 1 线下
source	String	退款来源 - order 订单
reason	String	退款原因简要说明 长度80字符
remark	String	退款详细备注
payRemark	String	付款说明
attachments	Object[]	退款附件
attachments.[].title	String	附件标题
attachments.[].description	String	附件说明
attachments.[].binaryId	String[]	附件id
extraProps	Object	扩展属性
crDate	String	创建时间
tenantId	String	租户ID
id	Varies	唯一标识

下载结果模型定义