# 1.1 退款接口

# 简要描述

  • 退款接口

# 请求URL

  • {domain}/open-api/payment/refund

# 请求头

参数名 必选 类型 说明
Content-Type mandatory string application/json

# 请求体参数

参数名 必选 类型 说明
appId string 应用APPID
param string 参数体
sign string 签名

# 请求参数

参数名 必选 类型 长度 示例 说明
mchRefundOrderId string 1-32 1677495496979 商户退款订单id, 格式:字母+数字,1-32位
originalTransactionId string 1-32 CCP20220428011068111 原交易流水号
refundAmount Long - - 退款金额(以分为单位)
refundReason string 1-200 - 退款原因
refundCallbackUrl string 1-256 - 退款回调Url
timestamp long - 1677495496979 当前时间戳

# 请求示例

# 请求体

{
  "appId": "733b887a4a784708bb369524db5b6ded",
  "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
  "param": "{\"originalTransactionId\":\"CU518563189147832780\",\"mchRefundOrderId\":\"refund488455057142\",\"refundAmount\":10000,\"refundReason\":\"testRefund\",\"refundCallbackUrl\":\"http://www.test.com\",\"timestamp\":1722415059}"
}

如何构造请求体


# 响应参数

参数名 类型 说明
code integer 响应码
message string 响应信息
data Object 数据

# data参数

参数名 类型 说明
mchRefundOrderId string 商户退款订单id
refundTransactionId string 退款交易流水号
refundCreateTime string 退款创建时间
refundAmount Long 退款金额(单位为分)
refundStatus string 退款交易状态

# 响应示例

{
  "code": 10000,
  "message": "Success",
  "data": {
    "mchRefundOrderId": "refund488455057142",
    "refundTransactionId": "1818566685947728",
    "refundCreateTime": "2024-07-31 16:37:40",
    "refundAmount": 10000,
    "refundStatus": "PENDING"
  }
}

响应码集合

# 返回失败案例

{
  "code": 21016,
  "message": "Merchant ip forbidden"
}