Skip to content

发起退款

请求方式和路径

POST /payment/payin/v1/createRefund

请求头

字段名类型必传描述
content-typestringapplication/json
x-api-keystringPaydify提供,跟appId相同
x-api-timestampstring时间戳,单位毫秒
x-api-signaturestring签名,具体参看签名算法

请求体

字段名类型必传描述
appIdstring(20)Paydify提供
mchTxnIdstring(60)商户侧订单ID
paymentTxnIdstring(30)支付订单ID
txnHashstring(120)链上的交易Hash
mchExtInfostring(512)商户扩展信息,JSON字符串

响应头参数

字段名类型必传描述
x-api-keystringPaydify提供,跟appId相同
x-api-timestampstring时间戳,单位毫秒
x-api-signaturestring签名,具体参看签名算法

返回值

字段名类型描述
statusint请求错误码,0表示成功,非0表示失败 ,枚举值参看错误码
msgstring请求错误描述信息
data.refundTxnIdstringPaydify侧的退款订单ID
data.paymentTxnIdstring关联的支付订单ID
data.statestring退款状态,枚举值参看退款状态
data.errorMsgstring退款失败原因说明

示例

shell
# 请求

# 成功返回值
{
  "status": 0,
  "msg": "success",
  "data": {
    "refundTxnId": "2209141130105863014",
    "paymentTxnId": "2209141130105863014",
    "state": "pending",
    "errorMsg": "xxx"
  }
}

# 失败返回值
{
  "status": 9999,
  "msg": "system error",
  "data": null
}
# 请求

# 成功返回值
{
  "status": 0,
  "msg": "success",
  "data": {
    "refundTxnId": "2209141130105863014",
    "paymentTxnId": "2209141130105863014",
    "state": "pending",
    "errorMsg": "xxx"
  }
}

# 失败返回值
{
  "status": 9999,
  "msg": "system error",
  "data": null
}