Skip to content

在线退款

简述

  • 商户在线退款申请接口

请求 URL

  • /pay/merchant/refund

请求参数

  • body
参数名必选类型长度说明
merchantIdString32商户编码
merRefundOrderIdString64商户退款订单号,在商户系统保证唯一
origOrderId条件String32平台原交易订单号,与 origMerOrderId 上送其一
origMerOrderId条件String64商户原交易订单号,与 origOrderId 上送其一
refundAmtString12退款金额,两位小数,格式:100.00
refundCurrencyString10退款币种
refundDescString128退款说明
serverNotifyUrlString255服务端退款结果通知地址。商户如果传该字段,以此 URL 为准给商户服务端回调;如果未传该字段,以后端配置的 URL 给商户服务端回调

请求示例

json
{
  "merchantId": "M12345678",
  "merRefundOrderId": "255456464654564564484",
  "origOrderId": "TRD2025011015332312345",
  "origMerOrderId": "",
  "refundAmt": "20.00",
  "refundCurrency": "SAR",
  "refundDesc": "refund",
  "serverNotifyUrl": "https://xxxx.com/notify"
}

响应参数

  • data
参数名类型说明
merchantIdString商户编码
refundOrderIdString平台退款订单号
merRefundOrderIdString商户退款订单号,同请求
refundAmtString交易金额 两位小数 格式:100.00
refundCurrencyString退款币种
refundTimeString退款时间,格式:YYYY-MM-DD HH:MM:SS
refundChannelString退款渠道,固定值:original(原路退款)
refundStatusString退款状态:
init:初始化
pending:处理中
success:退款成功
fail:失败
origOrdInfoObject原交易信息,对象格式,(Object:origOrdInfo)
  • Object:origOrdInfo
参数名类型说明
origOrderIdString原交易订单号
origMerOrderIdString原交易商户订单号
origOrderAmtString原交易金额
origRefundedAmtString原交易已成功退款金额
origRemainAmtString原交易剩余退款金额

响应示例

json
{
  "code": 10000,
  "message": "success",
  "data": {
    "merchantId": "M12345678",
    "refundOrderId": "REF202412131543011234578",
    "merRefundOrderId": "202412131543011234572332",
    "refundAmt": "20.00",
    "refundCurrency": "SAR",
    "refundTime": "2024-12-13 18:05:03",
    "refundChannel": "original",
    "refundStatus": "pending",
    "origOrdInfo": {
      "origOrderId": "TRD20241210153120123456",
      "origMerOrderId": "20241210153323032323",
      "origOrderAmt": "100.00",
      "origRefundedAmt": "20.00",
      "origRemainAmt": "80.00"
    }
  }
}